AzureConnectParam.Builder.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370
  1. <!DOCTYPE HTML>
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (11.0.18) on Fri Mar 29 17:34:29 CST 2024 -->
  6. <title>AzureConnectParam.Builder</title>
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2024-03-29">
  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="AzureConnectParam.Builder";
  26. }
  27. }
  28. catch(err) {
  29. }
  30. //-->
  31. var data = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10};
  32. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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.connect</a></div>
  120. <h2 title="Class AzureConnectParam.Builder" class="title">Class AzureConnectParam.Builder</h2>
  121. </div>
  122. <div class="contentContainer">
  123. <ul class="inheritance">
  124. <li>java.lang.Object</li>
  125. <li>
  126. <ul class="inheritance">
  127. <li>io.milvus.bulkwriter.connect.AzureConnectParam.Builder</li>
  128. </ul>
  129. </li>
  130. </ul>
  131. <div class="description">
  132. <ul class="blockList">
  133. <li class="blockList">
  134. <dl>
  135. <dt>Enclosing class:</dt>
  136. <dd><a href="AzureConnectParam.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam</a></dd>
  137. </dl>
  138. <hr>
  139. <pre>public static final class <span class="typeNameLabel">AzureConnectParam.Builder</span>
  140. extends java.lang.Object</pre>
  141. <div class="block">Builder for <a href="AzureConnectParam.html" title="class in io.milvus.bulkwriter.connect"><code>AzureConnectParam</code></a> class.</div>
  142. </li>
  143. </ul>
  144. </div>
  145. <div class="summary">
  146. <ul class="blockList">
  147. <li class="blockList">
  148. <!-- ========== METHOD SUMMARY =========== -->
  149. <section>
  150. <ul class="blockList">
  151. <li class="blockList"><a id="method.summary">
  152. <!-- -->
  153. </a>
  154. <h3>Method Summary</h3>
  155. <table class="memberSummary">
  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. <tr>
  158. <th class="colFirst" scope="col">Modifier and Type</th>
  159. <th class="colSecond" scope="col">Method</th>
  160. <th class="colLast" scope="col">Description</th>
  161. </tr>
  162. <tr id="i0" class="altColor">
  163. <td class="colFirst"><code><a href="AzureConnectParam.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam</a></code></td>
  164. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#build()">build</a></span>()</code></th>
  165. <td class="colLast">
  166. <div class="block">Verifies parameters and creates a new <a href="AzureConnectParam.html" title="class in io.milvus.bulkwriter.connect"><code>AzureConnectParam</code></a> instance.</div>
  167. </td>
  168. </tr>
  169. <tr id="i1" class="rowColor">
  170. <td class="colFirst"><code><a href="AzureConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam.Builder</a></code></td>
  171. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withAccountUrl(java.lang.String)">withAccountUrl</a></span>&#8203;(@NonNull java.lang.String&nbsp;accountUrl)</code></th>
  172. <td class="colLast">&nbsp;</td>
  173. </tr>
  174. <tr id="i2" class="altColor">
  175. <td class="colFirst"><code><a href="AzureConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam.Builder</a></code></td>
  176. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withConnStr(java.lang.String)">withConnStr</a></span>&#8203;(@NonNull java.lang.String&nbsp;connStr)</code></th>
  177. <td class="colLast">&nbsp;</td>
  178. </tr>
  179. <tr id="i3" class="rowColor">
  180. <td class="colFirst"><code><a href="AzureConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam.Builder</a></code></td>
  181. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withContainerName(java.lang.String)">withContainerName</a></span>&#8203;(@NonNull java.lang.String&nbsp;containerName)</code></th>
  182. <td class="colLast">&nbsp;</td>
  183. </tr>
  184. <tr id="i4" class="altColor">
  185. <td class="colFirst"><code><a href="AzureConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam.Builder</a></code></td>
  186. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#withCredential(com.azure.core.credential.TokenCredential)">withCredential</a></span>&#8203;(@NonNull com.azure.core.credential.TokenCredential&nbsp;credential)</code></th>
  187. <td class="colLast">&nbsp;</td>
  188. </tr>
  189. </table>
  190. <ul class="blockList">
  191. <li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">
  192. <!-- -->
  193. </a>
  194. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
  195. <code>equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
  196. </ul>
  197. </li>
  198. </ul>
  199. </section>
  200. </li>
  201. </ul>
  202. </div>
  203. <div class="details">
  204. <ul class="blockList">
  205. <li class="blockList">
  206. <!-- ============ METHOD DETAIL ========== -->
  207. <section>
  208. <ul class="blockList">
  209. <li class="blockList"><a id="method.detail">
  210. <!-- -->
  211. </a>
  212. <h3>Method Detail</h3>
  213. <a id="withContainerName(java.lang.String)">
  214. <!-- -->
  215. </a>
  216. <ul class="blockList">
  217. <li class="blockList">
  218. <h4>withContainerName</h4>
  219. <pre class="methodSignature">public&nbsp;<a href="AzureConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam.Builder</a>&nbsp;withContainerName&#8203;(@NonNull
  220. @NonNull java.lang.String&nbsp;containerName)</pre>
  221. <dl>
  222. <dt><span class="paramLabel">Parameters:</span></dt>
  223. <dd><code>containerName</code> - The target container name</dd>
  224. <dt><span class="returnLabel">Returns:</span></dt>
  225. <dd><code>Builder</code></dd>
  226. </dl>
  227. </li>
  228. </ul>
  229. <a id="withConnStr(java.lang.String)">
  230. <!-- -->
  231. </a>
  232. <ul class="blockList">
  233. <li class="blockList">
  234. <h4>withConnStr</h4>
  235. <pre class="methodSignature">public&nbsp;<a href="AzureConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam.Builder</a>&nbsp;withConnStr&#8203;(@NonNull
  236. @NonNull java.lang.String&nbsp;connStr)</pre>
  237. <dl>
  238. <dt><span class="paramLabel">Parameters:</span></dt>
  239. <dd><code>connStr</code> - A connection string to an Azure Storage account,
  240. which can be parsed to an account_url and a credential.
  241. To generate a connection string, read this link:
  242. <a href="https://learn.microsoft.com/en-us/azure/storage/common/storage-configure-connection-string">...</a></dd>
  243. <dt><span class="returnLabel">Returns:</span></dt>
  244. <dd><code>Builder</code></dd>
  245. </dl>
  246. </li>
  247. </ul>
  248. <a id="withAccountUrl(java.lang.String)">
  249. <!-- -->
  250. </a>
  251. <ul class="blockList">
  252. <li class="blockList">
  253. <h4>withAccountUrl</h4>
  254. <pre class="methodSignature">public&nbsp;<a href="AzureConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam.Builder</a>&nbsp;withAccountUrl&#8203;(@NonNull
  255. @NonNull java.lang.String&nbsp;accountUrl)</pre>
  256. <dl>
  257. <dt><span class="paramLabel">Parameters:</span></dt>
  258. <dd><code>accountUrl</code> - A string in format like https://<storage-account>.blob.core.windows.net
  259. Read this link for more info:
  260. <a href="https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview">...</a></dd>
  261. <dt><span class="returnLabel">Returns:</span></dt>
  262. <dd><code>Builder</code></dd>
  263. </dl>
  264. </li>
  265. </ul>
  266. <a id="withCredential(com.azure.core.credential.TokenCredential)">
  267. <!-- -->
  268. </a>
  269. <ul class="blockList">
  270. <li class="blockList">
  271. <h4>withCredential</h4>
  272. <pre class="methodSignature">public&nbsp;<a href="AzureConnectParam.Builder.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam.Builder</a>&nbsp;withCredential&#8203;(@NonNull
  273. @NonNull com.azure.core.credential.TokenCredential&nbsp;credential)</pre>
  274. <dl>
  275. <dt><span class="paramLabel">Parameters:</span></dt>
  276. <dd><code>credential</code> - Account access key for the account, read this link for more info:
  277. <a href="https://learn.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys">...</a></dd>
  278. <dt><span class="returnLabel">Returns:</span></dt>
  279. <dd><code>Builder</code></dd>
  280. </dl>
  281. </li>
  282. </ul>
  283. <a id="build()">
  284. <!-- -->
  285. </a>
  286. <ul class="blockListLast">
  287. <li class="blockList">
  288. <h4>build</h4>
  289. <pre class="methodSignature">public&nbsp;<a href="AzureConnectParam.html" title="class in io.milvus.bulkwriter.connect">AzureConnectParam</a>&nbsp;build()
  290. throws <a href="../../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></pre>
  291. <div class="block">Verifies parameters and creates a new <a href="AzureConnectParam.html" title="class in io.milvus.bulkwriter.connect"><code>AzureConnectParam</code></a> instance.</div>
  292. <dl>
  293. <dt><span class="returnLabel">Returns:</span></dt>
  294. <dd><a href="AzureConnectParam.html" title="class in io.milvus.bulkwriter.connect"><code>AzureConnectParam</code></a></dd>
  295. <dt><span class="throwsLabel">Throws:</span></dt>
  296. <dd><code><a href="../../exception/ParamException.html" title="class in io.milvus.exception">ParamException</a></code></dd>
  297. </dl>
  298. </li>
  299. </ul>
  300. </li>
  301. </ul>
  302. </section>
  303. </li>
  304. </ul>
  305. </div>
  306. </div>
  307. </main>
  308. <!-- ========= END OF CLASS DATA ========= -->
  309. <footer role="contentinfo">
  310. <nav role="navigation">
  311. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  312. <div class="bottomNav"><a id="navbar.bottom">
  313. <!-- -->
  314. </a>
  315. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  316. <a id="navbar.bottom.firstrow">
  317. <!-- -->
  318. </a>
  319. <ul class="navList" title="Navigation">
  320. <li><a href="../../../../index.html">Overview</a></li>
  321. <li><a href="package-summary.html">Package</a></li>
  322. <li class="navBarCell1Rev">Class</li>
  323. <li><a href="package-tree.html">Tree</a></li>
  324. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  325. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  326. <li><a href="../../../../help-doc.html">Help</a></li>
  327. </ul>
  328. </div>
  329. <div class="subNav">
  330. <ul class="navList" id="allclasses_navbar_bottom">
  331. <li><a href="../../../../allclasses.html">All&nbsp;Classes</a></li>
  332. </ul>
  333. <div>
  334. <script type="text/javascript"><!--
  335. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  336. if(window==top) {
  337. allClassesLink.style.display = "block";
  338. }
  339. else {
  340. allClassesLink.style.display = "none";
  341. }
  342. //-->
  343. </script>
  344. <noscript>
  345. <div>JavaScript is disabled on your browser.</div>
  346. </noscript>
  347. </div>
  348. <div>
  349. <ul class="subNavList">
  350. <li>Summary:&nbsp;</li>
  351. <li>Nested&nbsp;|&nbsp;</li>
  352. <li>Field&nbsp;|&nbsp;</li>
  353. <li>Constr&nbsp;|&nbsp;</li>
  354. <li><a href="#method.summary">Method</a></li>
  355. </ul>
  356. <ul class="subNavList">
  357. <li>Detail:&nbsp;</li>
  358. <li>Field&nbsp;|&nbsp;</li>
  359. <li>Constr&nbsp;|&nbsp;</li>
  360. <li><a href="#method.detail">Method</a></li>
  361. </ul>
  362. </div>
  363. <a id="skip.navbar.bottom">
  364. <!-- -->
  365. </a></div>
  366. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  367. </nav>
  368. </footer>
  369. </body>
  370. </html>