S3ConnectParam.Builder.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  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 11 16:54:25 CST 2024 -->
  6. <title>S3ConnectParam.Builder</title>
  7. <meta name="date" content="2024-10-11">
  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="S3ConnectParam.Builder";
  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":10,"i8":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/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  52. <li><a href="../../../../io/milvus/bulkwriter/connect/StorageConnectParam.html" title="class in io.milvus.bulkwriter.connect"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  53. </ul>
  54. <ul class="navList">
  55. <li><a href="../../../../index.html?io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" target="_top">Frames</a></li>
  56. <li><a href="S3ConnectParam.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.connect</div>
  95. <h2 title="Class S3ConnectParam.Builder" class="title">Class S3ConnectParam.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.connect.S3ConnectParam.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/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam</a></dd>
  112. </dl>
  113. <hr>
  114. <br>
  115. <pre>public static final class <span class="typeNameLabel">S3ConnectParam.Builder</span>
  116. extends java.lang.Object</pre>
  117. <div class="block">Builder for <a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect"><code>S3ConnectParam</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/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam</a></code></td>
  138. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#build--">build</a></span>()</code>
  139. <div class="block">Verifies parameters and creates a new <a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect"><code>S3ConnectParam</code></a> instance.</div>
  140. </td>
  141. </tr>
  142. <tr id="i1" class="rowColor">
  143. <td class="colFirst"><code><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a></code></td>
  144. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#withAccessKey-java.lang.String-">withAccessKey</a></span>(@NonNull java.lang.String&nbsp;accessKey)</code>&nbsp;</td>
  145. </tr>
  146. <tr id="i2" class="altColor">
  147. <td class="colFirst"><code><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a></code></td>
  148. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#withBucketName-java.lang.String-">withBucketName</a></span>(@NonNull java.lang.String&nbsp;bucketName)</code>
  149. <div class="block">Sets the bucketName info.</div>
  150. </td>
  151. </tr>
  152. <tr id="i3" class="rowColor">
  153. <td class="colFirst"><code><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a></code></td>
  154. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#withCloudName-java.lang.String-">withCloudName</a></span>(java.lang.String&nbsp;cloudName)</code>
  155. <div class="block">Sets the cloudName.</div>
  156. </td>
  157. </tr>
  158. <tr id="i4" class="altColor">
  159. <td class="colFirst"><code><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a></code></td>
  160. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#withEndpoint-java.lang.String-">withEndpoint</a></span>(@NonNull java.lang.String&nbsp;endpoint)</code>
  161. <div class="block">Sets the endpoint.</div>
  162. </td>
  163. </tr>
  164. <tr id="i5" class="rowColor">
  165. <td class="colFirst"><code><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a></code></td>
  166. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#withHttpClient-okhttp3.OkHttpClient-">withHttpClient</a></span>(@NonNull okhttp3.OkHttpClient&nbsp;httpClient)</code>&nbsp;</td>
  167. </tr>
  168. <tr id="i6" class="altColor">
  169. <td class="colFirst"><code><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a></code></td>
  170. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#withRegion-java.lang.String-">withRegion</a></span>(@NonNull java.lang.String&nbsp;region)</code>&nbsp;</td>
  171. </tr>
  172. <tr id="i7" class="rowColor">
  173. <td class="colFirst"><code><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a></code></td>
  174. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#withSecretKey-java.lang.String-">withSecretKey</a></span>(@NonNull java.lang.String&nbsp;secretKey)</code>&nbsp;</td>
  175. </tr>
  176. <tr id="i8" class="altColor">
  177. <td class="colFirst"><code><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a></code></td>
  178. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html#withSessionToken-java.lang.String-">withSessionToken</a></span>(@NonNull java.lang.String&nbsp;sessionToken)</code>&nbsp;</td>
  179. </tr>
  180. </table>
  181. <ul class="blockList">
  182. <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
  183. <!-- -->
  184. </a>
  185. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  186. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  187. </ul>
  188. </li>
  189. </ul>
  190. </li>
  191. </ul>
  192. </div>
  193. <div class="details">
  194. <ul class="blockList">
  195. <li class="blockList">
  196. <!-- ============ METHOD DETAIL ========== -->
  197. <ul class="blockList">
  198. <li class="blockList"><a name="method.detail">
  199. <!-- -->
  200. </a>
  201. <h3>Method Detail</h3>
  202. <a name="withCloudName-java.lang.String-">
  203. <!-- -->
  204. </a>
  205. <ul class="blockList">
  206. <li class="blockList">
  207. <h4>withCloudName</h4>
  208. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a>&nbsp;withCloudName(@NotNull
  209. java.lang.String&nbsp;cloudName)</pre>
  210. <div class="block">Sets the cloudName.</div>
  211. <dl>
  212. <dt><span class="paramLabel">Parameters:</span></dt>
  213. <dd><code>cloudName</code> - cloud name</dd>
  214. <dt><span class="returnLabel">Returns:</span></dt>
  215. <dd><code>Builder</code></dd>
  216. </dl>
  217. </li>
  218. </ul>
  219. <a name="withBucketName-java.lang.String-">
  220. <!-- -->
  221. </a>
  222. <ul class="blockList">
  223. <li class="blockList">
  224. <h4>withBucketName</h4>
  225. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a>&nbsp;withBucketName(@NonNull
  226. @NonNull java.lang.String&nbsp;bucketName)</pre>
  227. <div class="block">Sets the bucketName info.</div>
  228. <dl>
  229. <dt><span class="paramLabel">Parameters:</span></dt>
  230. <dd><code>bucketName</code> - bucket info</dd>
  231. <dt><span class="returnLabel">Returns:</span></dt>
  232. <dd><code>Builder</code></dd>
  233. </dl>
  234. </li>
  235. </ul>
  236. <a name="withEndpoint-java.lang.String-">
  237. <!-- -->
  238. </a>
  239. <ul class="blockList">
  240. <li class="blockList">
  241. <h4>withEndpoint</h4>
  242. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a>&nbsp;withEndpoint(@NonNull
  243. @NonNull java.lang.String&nbsp;endpoint)</pre>
  244. <div class="block">Sets the endpoint.</div>
  245. <dl>
  246. <dt><span class="paramLabel">Parameters:</span></dt>
  247. <dd><code>endpoint</code> - endpoint info</dd>
  248. <dt><span class="returnLabel">Returns:</span></dt>
  249. <dd><code>Builder</code></dd>
  250. </dl>
  251. </li>
  252. </ul>
  253. <a name="withAccessKey-java.lang.String-">
  254. <!-- -->
  255. </a>
  256. <ul class="blockList">
  257. <li class="blockList">
  258. <h4>withAccessKey</h4>
  259. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a>&nbsp;withAccessKey(@NonNull
  260. @NonNull java.lang.String&nbsp;accessKey)</pre>
  261. </li>
  262. </ul>
  263. <a name="withSecretKey-java.lang.String-">
  264. <!-- -->
  265. </a>
  266. <ul class="blockList">
  267. <li class="blockList">
  268. <h4>withSecretKey</h4>
  269. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a>&nbsp;withSecretKey(@NonNull
  270. @NonNull java.lang.String&nbsp;secretKey)</pre>
  271. </li>
  272. </ul>
  273. <a name="withSessionToken-java.lang.String-">
  274. <!-- -->
  275. </a>
  276. <ul class="blockList">
  277. <li class="blockList">
  278. <h4>withSessionToken</h4>
  279. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a>&nbsp;withSessionToken(@NonNull
  280. @NonNull java.lang.String&nbsp;sessionToken)</pre>
  281. </li>
  282. </ul>
  283. <a name="withRegion-java.lang.String-">
  284. <!-- -->
  285. </a>
  286. <ul class="blockList">
  287. <li class="blockList">
  288. <h4>withRegion</h4>
  289. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a>&nbsp;withRegion(@NonNull
  290. @NonNull java.lang.String&nbsp;region)</pre>
  291. </li>
  292. </ul>
  293. <a name="withHttpClient-okhttp3.OkHttpClient-">
  294. <!-- -->
  295. </a>
  296. <ul class="blockList">
  297. <li class="blockList">
  298. <h4>withHttpClient</h4>
  299. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam.Builder</a>&nbsp;withHttpClient(@NonNull
  300. @NonNull okhttp3.OkHttpClient&nbsp;httpClient)</pre>
  301. </li>
  302. </ul>
  303. <a name="build--">
  304. <!-- -->
  305. </a>
  306. <ul class="blockListLast">
  307. <li class="blockList">
  308. <h4>build</h4>
  309. <pre>public&nbsp;<a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect">S3ConnectParam</a>&nbsp;build()
  310. throws <a href="../../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  311. <div class="block">Verifies parameters and creates a new <a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect"><code>S3ConnectParam</code></a> instance.</div>
  312. <dl>
  313. <dt><span class="returnLabel">Returns:</span></dt>
  314. <dd><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect"><code>S3ConnectParam</code></a></dd>
  315. <dt><span class="throwsLabel">Throws:</span></dt>
  316. <dd><code><a href="../../../../io/milvus/exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  317. </dl>
  318. </li>
  319. </ul>
  320. </li>
  321. </ul>
  322. </li>
  323. </ul>
  324. </div>
  325. </div>
  326. <!-- ========= END OF CLASS DATA ========= -->
  327. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  328. <div class="bottomNav"><a name="navbar.bottom">
  329. <!-- -->
  330. </a>
  331. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  332. <a name="navbar.bottom.firstrow">
  333. <!-- -->
  334. </a>
  335. <ul class="navList" title="Navigation">
  336. <li><a href="../../../../overview-summary.html">Overview</a></li>
  337. <li><a href="package-summary.html">Package</a></li>
  338. <li class="navBarCell1Rev">Class</li>
  339. <li><a href="package-tree.html">Tree</a></li>
  340. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  341. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  342. <li><a href="../../../../help-doc.html">Help</a></li>
  343. </ul>
  344. </div>
  345. <div class="subNav">
  346. <ul class="navList">
  347. <li><a href="../../../../io/milvus/bulkwriter/connect/S3ConnectParam.html" title="class in io.milvus.bulkwriter.connect"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  348. <li><a href="../../../../io/milvus/bulkwriter/connect/StorageConnectParam.html" title="class in io.milvus.bulkwriter.connect"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  349. </ul>
  350. <ul class="navList">
  351. <li><a href="../../../../index.html?io/milvus/bulkwriter/connect/S3ConnectParam.Builder.html" target="_top">Frames</a></li>
  352. <li><a href="S3ConnectParam.Builder.html" target="_top">No&nbsp;Frames</a></li>
  353. </ul>
  354. <ul class="navList" id="allclasses_navbar_bottom">
  355. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  356. </ul>
  357. <div>
  358. <script type="text/javascript"><!--
  359. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  360. if(window==top) {
  361. allClassesLink.style.display = "block";
  362. }
  363. else {
  364. allClassesLink.style.display = "none";
  365. }
  366. //-->
  367. </script>
  368. </div>
  369. <div>
  370. <ul class="subNavList">
  371. <li>Summary:&nbsp;</li>
  372. <li>Nested&nbsp;|&nbsp;</li>
  373. <li>Field&nbsp;|&nbsp;</li>
  374. <li>Constr&nbsp;|&nbsp;</li>
  375. <li><a href="#method.summary">Method</a></li>
  376. </ul>
  377. <ul class="subNavList">
  378. <li>Detail:&nbsp;</li>
  379. <li>Field&nbsp;|&nbsp;</li>
  380. <li>Constr&nbsp;|&nbsp;</li>
  381. <li><a href="#method.detail">Method</a></li>
  382. </ul>
  383. </div>
  384. <a name="skip.navbar.bottom">
  385. <!-- -->
  386. </a></div>
  387. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  388. </body>
  389. </html>