StorageClient.html 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.18) on Fri Apr 19 15:06:25 CST 2024 -->
  6. <title>StorageClient</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2024-04-19">
  9. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  10. <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.min.css" title="Style">
  11. <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style">
  12. <script type="text/javascript" src="../../../../script.js"></script>
  13. <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script>
  14. <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
  15. <!--[if IE]>
  16. <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
  17. <![endif]-->
  18. <script type="text/javascript" src="../../../../jquery/jquery-3.6.0.min.js"></script>
  19. <script type="text/javascript" src="../../../../jquery/jquery-ui.min.js"></script>
  20. </head>
  21. <body>
  22. <script type="text/javascript"><!--
  23. try {
  24. if (location.href.indexOf('is-external=true') == -1) {
  25. parent.document.title="StorageClient";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":6,"i1":6,"i2":6};
  32. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  33. var altColor = "altColor";
  34. var rowColor = "rowColor";
  35. var tableTab = "tableTab";
  36. var activeTableTab = "activeTableTab";
  37. var pathtoroot = "../../../../";
  38. var useModuleDirectories = true;
  39. loadScripts(document, 'script');</script>
  40. <noscript>
  41. <div>JavaScript is disabled on your browser.</div>
  42. </noscript>
  43. <header role="banner">
  44. <nav role="navigation">
  45. <div class="fixedNav">
  46. <!-- ========= START OF TOP NAVBAR ======= -->
  47. <div class="topNav"><a id="navbar.top">
  48. <!-- -->
  49. </a>
  50. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  51. <a id="navbar.top.firstrow">
  52. <!-- -->
  53. </a>
  54. <ul class="navList" title="Navigation">
  55. <li><a href="../../../../index.html">Overview</a></li>
  56. <li><a href="package-summary.html">Package</a></li>
  57. <li class="navBarCell1Rev">Class</li>
  58. <li><a href="package-tree.html">Tree</a></li>
  59. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  60. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  61. <li><a href="../../../../help-doc.html">Help</a></li>
  62. </ul>
  63. </div>
  64. <div class="subNav">
  65. <ul class="navList" id="allclasses_navbar_top">
  66. <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
  67. </ul>
  68. <ul class="navListSearch">
  69. <li><label for="search">SEARCH:</label>
  70. <input type="text" id="search" value="search" disabled="disabled">
  71. <input type="reset" id="reset" value="reset" disabled="disabled">
  72. </li>
  73. </ul>
  74. <div>
  75. <script type="text/javascript"><!--
  76. allClassesLink = document.getElementById("allclasses_navbar_top");
  77. if(window==top) {
  78. allClassesLink.style.display = "block";
  79. }
  80. else {
  81. allClassesLink.style.display = "none";
  82. }
  83. //-->
  84. </script>
  85. <noscript>
  86. <div>JavaScript is disabled on your browser.</div>
  87. </noscript>
  88. </div>
  89. <div>
  90. <ul class="subNavList">
  91. <li>Summary:&nbsp;</li>
  92. <li>Nested&nbsp;|&nbsp;</li>
  93. <li>Field&nbsp;|&nbsp;</li>
  94. <li>Constr&nbsp;|&nbsp;</li>
  95. <li><a href="#method.summary">Method</a></li>
  96. </ul>
  97. <ul class="subNavList">
  98. <li>Detail:&nbsp;</li>
  99. <li>Field&nbsp;|&nbsp;</li>
  100. <li>Constr&nbsp;|&nbsp;</li>
  101. <li><a href="#method.detail">Method</a></li>
  102. </ul>
  103. </div>
  104. <a id="skip.navbar.top">
  105. <!-- -->
  106. </a></div>
  107. <!-- ========= END OF TOP NAVBAR ========= -->
  108. </div>
  109. <div class="navPadding">&nbsp;</div>
  110. <script type="text/javascript"><!--
  111. $('.navPadding').css('padding-top', $('.fixedNav').css("height"));
  112. //-->
  113. </script>
  114. </nav>
  115. </header>
  116. <!-- ======== START OF CLASS DATA ======== -->
  117. <main role="main">
  118. <div class="header">
  119. <div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">io.milvus.bulkwriter.storage</a></div>
  120. <h2 title="Interface StorageClient" class="title">Interface StorageClient</h2>
  121. </div>
  122. <div class="contentContainer">
  123. <div class="description">
  124. <ul class="blockList">
  125. <li class="blockList">
  126. <dl>
  127. <dt>All Known Implementing Classes:</dt>
  128. <dd><code><a href="client/AzureStorageClient.html" title="class in io.milvus.bulkwriter.storage.client">AzureStorageClient</a></code>, <code><a href="client/MinioStorageClient.html" title="class in io.milvus.bulkwriter.storage.client">MinioStorageClient</a></code></dd>
  129. </dl>
  130. <hr>
  131. <pre>public interface <span class="typeNameLabel">StorageClient</span></pre>
  132. </li>
  133. </ul>
  134. </div>
  135. <div class="summary">
  136. <ul class="blockList">
  137. <li class="blockList">
  138. <!-- ========== METHOD SUMMARY =========== -->
  139. <section>
  140. <ul class="blockList">
  141. <li class="blockList"><a id="method.summary">
  142. <!-- -->
  143. </a>
  144. <h3>Method Summary</h3>
  145. <table class="memberSummary">
  146. <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="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  147. <tr>
  148. <th class="colFirst" scope="col">Modifier and Type</th>
  149. <th class="colSecond" scope="col">Method</th>
  150. <th class="colLast" scope="col">Description</th>
  151. </tr>
  152. <tr id="i0" class="altColor">
  153. <td class="colFirst"><code>boolean</code></td>
  154. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#checkBucketExist(java.lang.String)">checkBucketExist</a></span>&#8203;(java.lang.String&nbsp;bucketName)</code></th>
  155. <td class="colLast">&nbsp;</td>
  156. </tr>
  157. <tr id="i1" class="rowColor">
  158. <td class="colFirst"><code>java.lang.Long</code></td>
  159. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getObjectEntity(java.lang.String,java.lang.String)">getObjectEntity</a></span>&#8203;(java.lang.String&nbsp;bucketName,
  160. java.lang.String&nbsp;objectKey)</code></th>
  161. <td class="colLast">&nbsp;</td>
  162. </tr>
  163. <tr id="i2" class="altColor">
  164. <td class="colFirst"><code>void</code></td>
  165. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#putObjectStream(java.io.InputStream,long,java.lang.String,java.lang.String)">putObjectStream</a></span>&#8203;(java.io.InputStream&nbsp;inputStream,
  166. long&nbsp;contentLength,
  167. java.lang.String&nbsp;bucketName,
  168. java.lang.String&nbsp;objectKey)</code></th>
  169. <td class="colLast">&nbsp;</td>
  170. </tr>
  171. </table>
  172. </li>
  173. </ul>
  174. </section>
  175. </li>
  176. </ul>
  177. </div>
  178. <div class="details">
  179. <ul class="blockList">
  180. <li class="blockList">
  181. <!-- ============ METHOD DETAIL ========== -->
  182. <section>
  183. <ul class="blockList">
  184. <li class="blockList"><a id="method.detail">
  185. <!-- -->
  186. </a>
  187. <h3>Method Detail</h3>
  188. <a id="getObjectEntity(java.lang.String,java.lang.String)">
  189. <!-- -->
  190. </a>
  191. <ul class="blockList">
  192. <li class="blockList">
  193. <h4>getObjectEntity</h4>
  194. <pre class="methodSignature">java.lang.Long&nbsp;getObjectEntity&#8203;(java.lang.String&nbsp;bucketName,
  195. java.lang.String&nbsp;objectKey)
  196. throws java.lang.Exception</pre>
  197. <dl>
  198. <dt><span class="throwsLabel">Throws:</span></dt>
  199. <dd><code>java.lang.Exception</code></dd>
  200. </dl>
  201. </li>
  202. </ul>
  203. <a id="checkBucketExist(java.lang.String)">
  204. <!-- -->
  205. </a>
  206. <ul class="blockList">
  207. <li class="blockList">
  208. <h4>checkBucketExist</h4>
  209. <pre class="methodSignature">boolean&nbsp;checkBucketExist&#8203;(java.lang.String&nbsp;bucketName)
  210. throws java.lang.Exception</pre>
  211. <dl>
  212. <dt><span class="throwsLabel">Throws:</span></dt>
  213. <dd><code>java.lang.Exception</code></dd>
  214. </dl>
  215. </li>
  216. </ul>
  217. <a id="putObjectStream(java.io.InputStream,long,java.lang.String,java.lang.String)">
  218. <!-- -->
  219. </a>
  220. <ul class="blockListLast">
  221. <li class="blockList">
  222. <h4>putObjectStream</h4>
  223. <pre class="methodSignature">void&nbsp;putObjectStream&#8203;(java.io.InputStream&nbsp;inputStream,
  224. long&nbsp;contentLength,
  225. java.lang.String&nbsp;bucketName,
  226. java.lang.String&nbsp;objectKey)
  227. throws java.lang.Exception</pre>
  228. <dl>
  229. <dt><span class="throwsLabel">Throws:</span></dt>
  230. <dd><code>java.lang.Exception</code></dd>
  231. </dl>
  232. </li>
  233. </ul>
  234. </li>
  235. </ul>
  236. </section>
  237. </li>
  238. </ul>
  239. </div>
  240. </div>
  241. </main>
  242. <!-- ========= END OF CLASS DATA ========= -->
  243. <footer role="contentinfo">
  244. <nav role="navigation">
  245. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  246. <div class="bottomNav"><a id="navbar.bottom">
  247. <!-- -->
  248. </a>
  249. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  250. <a id="navbar.bottom.firstrow">
  251. <!-- -->
  252. </a>
  253. <ul class="navList" title="Navigation">
  254. <li><a href="../../../../index.html">Overview</a></li>
  255. <li><a href="package-summary.html">Package</a></li>
  256. <li class="navBarCell1Rev">Class</li>
  257. <li><a href="package-tree.html">Tree</a></li>
  258. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  259. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  260. <li><a href="../../../../help-doc.html">Help</a></li>
  261. </ul>
  262. </div>
  263. <div class="subNav">
  264. <ul class="navList" id="allclasses_navbar_bottom">
  265. <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
  266. </ul>
  267. <div>
  268. <script type="text/javascript"><!--
  269. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  270. if(window==top) {
  271. allClassesLink.style.display = "block";
  272. }
  273. else {
  274. allClassesLink.style.display = "none";
  275. }
  276. //-->
  277. </script>
  278. <noscript>
  279. <div>JavaScript is disabled on your browser.</div>
  280. </noscript>
  281. </div>
  282. <div>
  283. <ul class="subNavList">
  284. <li>Summary:&nbsp;</li>
  285. <li>Nested&nbsp;|&nbsp;</li>
  286. <li>Field&nbsp;|&nbsp;</li>
  287. <li>Constr&nbsp;|&nbsp;</li>
  288. <li><a href="#method.summary">Method</a></li>
  289. </ul>
  290. <ul class="subNavList">
  291. <li>Detail:&nbsp;</li>
  292. <li>Field&nbsp;|&nbsp;</li>
  293. <li>Constr&nbsp;|&nbsp;</li>
  294. <li><a href="#method.detail">Method</a></li>
  295. </ul>
  296. </div>
  297. <a id="skip.navbar.bottom">
  298. <!-- -->
  299. </a></div>
  300. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  301. </nav>
  302. </footer>
  303. </body>
  304. </html>