صفحهٔ اصلی گشت‌و‌گذار راهنما
ثبت نام ورود
milvus
/
milvus-sdk-java
mirrorاز https://github.com/milvus-io/milvus-sdk-java.git
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
درخت: 9482d0b07e
شاخه‌ها تگ‌ها
milvus-sdk-java
/
doc
/
io
/
milvus
/
param
/
ParamUtils.html

ParamUtils.html 23 KB
تاريخچه خام

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574 
  1. <!DOCTYPE HTML>
    2. 

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

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

  4. <head>
    5. 

  5. <!-- Generated by javadoc (11.0.18) on Wed Nov 08 12:07:04 CST 2023 -->
    6. 

  6. <title>ParamUtils</title>
    7. 

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

  8. <meta name="dc.created" content="2023-11-08">
    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="ParamUtils";
    26. 

  26.         }
    27. 

  27.     }
    28. 

  28.     catch(err) {
    29. 

  29.     }
    30. 

  30. //-->
    31. 

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

  32. var tabs = {65535:["t0","All Methods"],1:["t1","Static 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><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
    93. 

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

  94. <li><a href="#constructor.summary">Constr</a>&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><a href="#constructor.detail">Constr</a>&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</a></div>
    120. 

  120. <h2 title="Class ParamUtils" class="title">Class ParamUtils</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.ParamUtils</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. <hr>
    135. 

  135. <pre>public class <span class="typeNameLabel">ParamUtils</span>
    136. 

  136. extends java.lang.Object</pre>
    137. 

  137. <div class="block">Utility functions for param classes</div>
    138. 

  138. </li>
    139. 

  139. </ul>
    140. 

  140. </div>
    141. 

  141. <div class="summary">
    142. 

  142. <ul class="blockList">
    143. 

  143. <li class="blockList">
    144. 

  144. <!-- ======== NESTED CLASS SUMMARY ======== -->
    145. 

  145. <section>
    146. 

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

  147. <li class="blockList"><a id="nested.class.summary">
    148. 

  148. <!--   -->
    149. 

  149. </a>
    150. 

  150. <h3>Nested Class Summary</h3>
    151. 

  151. <table class="memberSummary">
    152. 

  152. <caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
    153. 

  153. <tr>
    154. 

  154. <th class="colFirst" scope="col">Modifier and Type</th>
    155. 

  155. <th class="colSecond" scope="col">Class</th>
    156. 

  156. <th class="colLast" scope="col">Description</th>
    157. 

  157. </tr>
    158. 

  158. <tr class="altColor">
    159. 

  159. <td class="colFirst"><code>static class&nbsp;</code></td>
    160. 

  160. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ParamUtils.InsertBuilderWrapper.html" title="class in io.milvus.param">ParamUtils.InsertBuilderWrapper</a></span></code></th>
    161. 

  161. <td class="colLast">&nbsp;</td>
    162. 

  162. </tr>
    163. 

  163. <tr class="rowColor">
    164. 

  164. <td class="colFirst"><code>static class&nbsp;</code></td>
    165. 

  165. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="ParamUtils.InsertDataInfo.html" title="class in io.milvus.param">ParamUtils.InsertDataInfo</a></span></code></th>
    166. 

  166. <td class="colLast">&nbsp;</td>
    167. 

  167. </tr>
    168. 

  168. </table>
    169. 

  169. </li>
    170. 

  170. </ul>
    171. 

  171. </section>
    172. 

  172. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
    173. 

  173. <section>
    174. 

  174. <ul class="blockList">
    175. 

  175. <li class="blockList"><a id="constructor.summary">
    176. 

  176. <!--   -->
    177. 

  177. </a>
    178. 

  178. <h3>Constructor Summary</h3>
    179. 

  179. <table class="memberSummary">
    180. 

  180. <caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
    181. 

  181. <tr>
    182. 

  182. <th class="colFirst" scope="col">Constructor</th>
    183. 

  183. <th class="colLast" scope="col">Description</th>
    184. 

  184. </tr>
    185. 

  185. <tr class="altColor">
    186. 

  186. <th class="colConstructorName" scope="row"><code><span class="memberNameLink"><a href="#%3Cinit%3E()">ParamUtils</a></span>()</code></th>
    187. 

  187. <td class="colLast">&nbsp;</td>
    188. 

  188. </tr>
    189. 

  189. </table>
    190. 

  190. </li>
    191. 

  191. </ul>
    192. 

  192. </section>
    193. 

  193. <!-- ========== METHOD SUMMARY =========== -->
    194. 

  194. <section>
    195. 

  195. <ul class="blockList">
    196. 

  196. <li class="blockList"><a id="method.summary">
    197. 

  197. <!--   -->
    198. 

  198. </a>
    199. 

  199. <h3>Method Summary</h3>
    200. 

  200. <table class="memberSummary">
    201. 

  201. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t1" class="tableTab"><span><a href="javascript:show(1);">Static 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>
    202. 

  202. <tr>
    203. 

  203. <th class="colFirst" scope="col">Modifier and Type</th>
    204. 

  204. <th class="colSecond" scope="col">Method</th>
    205. 

  205. <th class="colLast" scope="col">Description</th>
    206. 

  206. </tr>
    207. 

  207. <tr id="i0" class="altColor">
    208. 

  208. <td class="colFirst"><code>static java.util.List&lt;io.milvus.grpc.KeyValuePair&gt;</code></td>
    209. 

  209. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#AssembleKvPair(java.util.Map)">AssembleKvPair</a></span>&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;sourceMap)</code></th>
    210. 

  210. <td class="colLast">&nbsp;</td>
    211. 

  211. </tr>
    212. 

  212. <tr id="i1" class="rowColor">
    213. 

  213. <td class="colFirst"><code>static void</code></td>
    214. 

  214. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CheckNullEmptyString(java.lang.String,java.lang.String)">CheckNullEmptyString</a></span>&#8203;(java.lang.String&nbsp;target,
    215. 

  215.                     java.lang.String&nbsp;name)</code></th>
    216. 

  216. <td class="colLast">
    217. 

  217. <div class="block">Checks if a string is empty or null.</div>
    218. 

  218. </td>
    219. 

  219. </tr>
    220. 

  220. <tr id="i2" class="altColor">
    221. 

  221. <td class="colFirst"><code>static void</code></td>
    222. 

  222. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#CheckNullString(java.lang.String,java.lang.String)">CheckNullString</a></span>&#8203;(java.lang.String&nbsp;target,
    223. 

  223.                java.lang.String&nbsp;name)</code></th>
    224. 

  224. <td class="colLast">
    225. 

  225. <div class="block">Checks if a string is  null.</div>
    226. 

  226. </td>
    227. 

  227. </tr>
    228. 

  228. <tr id="i3" class="rowColor">
    229. 

  229. <td class="colFirst"><code>static <a href="collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
    230. 

  230. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#ConvertField(io.milvus.grpc.FieldSchema)">ConvertField</a></span>&#8203;(@NonNull io.milvus.grpc.FieldSchema&nbsp;field)</code></th>
    231. 

  231. <td class="colLast">
    232. 

  232. <div class="block">Convert a grpc field schema to client field schema</div>
    233. 

  233. </td>
    234. 

  234. </tr>
    235. 

  235. <tr id="i4" class="altColor">
    236. 

  236. <td class="colFirst"><code>static io.milvus.grpc.FieldSchema</code></td>
    237. 

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

  238. <td class="colLast">
    239. 

  239. <div class="block">Convert a client field schema to grpc field schema</div>
    240. 

  240. </td>
    241. 

  241. </tr>
    242. 

  242. <tr id="i5" class="rowColor">
    243. 

  243. <td class="colFirst"><code>static io.milvus.grpc.QueryRequest</code></td>
    244. 

  244. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertQueryParam(io.milvus.param.dml.QueryParam)">convertQueryParam</a></span>&#8203;(@NonNull <a href="dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</code></th>
    245. 

  245. <td class="colLast">&nbsp;</td>
    246. 

  246. </tr>
    247. 

  247. <tr id="i6" class="altColor">
    248. 

  248. <td class="colFirst"><code>static io.milvus.grpc.SearchRequest</code></td>
    249. 

  249. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#convertSearchParam(io.milvus.param.dml.SearchParam)">convertSearchParam</a></span>&#8203;(@NonNull <a href="dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)</code></th>
    250. 

  250. <td class="colLast">&nbsp;</td>
    251. 

  251. </tr>
    252. 

  252. <tr id="i7" class="rowColor">
    253. 

  253. <td class="colFirst"><code>static java.util.HashMap&lt;io.milvus.grpc.DataType,&#8203;java.lang.String&gt;</code></td>
    254. 

  254. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#getTypeErrorMsg()">getTypeErrorMsg</a></span>()</code></th>
    255. 

  255. <td class="colLast">&nbsp;</td>
    256. 

  256. </tr>
    257. 

  257. <tr id="i8" class="altColor">
    258. 

  258. <td class="colFirst"><code>static boolean</code></td>
    259. 

  259. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#IsBinaryMetric(io.milvus.param.MetricType)">IsBinaryMetric</a></span>&#8203;(<a href="MetricType.html" title="enum in io.milvus.param">MetricType</a>&nbsp;metric)</code></th>
    260. 

  260. <td class="colLast">
    261. 

  261. <div class="block">Checks if a metric is for binary vector.</div>
    262. 

  262. </td>
    263. 

  263. </tr>
    264. 

  264. <tr id="i9" class="rowColor">
    265. 

  265. <td class="colFirst"><code>static boolean</code></td>
    266. 

  266. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#IsFloatMetric(io.milvus.param.MetricType)">IsFloatMetric</a></span>&#8203;(<a href="MetricType.html" title="enum in io.milvus.param">MetricType</a>&nbsp;metric)</code></th>
    267. 

  267. <td class="colLast">
    268. 

  268. <div class="block">Checks if a metric is for float vector.</div>
    269. 

  269. </td>
    270. 

  270. </tr>
    271. 

  271. <tr id="i10" class="altColor">
    272. 

  272. <td class="colFirst"><code>static boolean</code></td>
    273. 

  273. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#IsVectorIndex(io.milvus.param.IndexType)">IsVectorIndex</a></span>&#8203;(<a href="IndexType.html" title="enum in io.milvus.param">IndexType</a>&nbsp;idx)</code></th>
    274. 

  274. <td class="colLast">
    275. 

  275. <div class="block">Checks if an index type is for vector field.</div>
    276. 

  276. </td>
    277. 

  277. </tr>
    278. 

  278. <tr id="i11" class="rowColor">
    279. 

  279. <td class="colFirst"><code>static boolean</code></td>
    280. 

  280. <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#VerifyIndexType(io.milvus.param.IndexType,io.milvus.grpc.DataType)">VerifyIndexType</a></span>&#8203;(<a href="IndexType.html" title="enum in io.milvus.param">IndexType</a>&nbsp;indexType,
    281. 

  281.                io.milvus.grpc.DataType&nbsp;dataType)</code></th>
    282. 

  282. <td class="colLast">
    283. 

  283. <div class="block">Checks if an index type is matched with data type.</div>
    284. 

  284. </td>
    285. 

  285. </tr>
    286. 

  286. </table>
    287. 

  287. <ul class="blockList">
    288. 

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

  289. <!--   -->
    290. 

  290. </a>
    291. 

  291. <h3>Methods inherited from class&nbsp;java.lang.Object</h3>
    292. 

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

  293. </ul>
    294. 

  294. </li>
    295. 

  295. </ul>
    296. 

  296. </section>
    297. 

  297. </li>
    298. 

  298. </ul>
    299. 

  299. </div>
    300. 

  300. <div class="details">
    301. 

  301. <ul class="blockList">
    302. 

  302. <li class="blockList">
    303. 

  303. <!-- ========= CONSTRUCTOR DETAIL ======== -->
    304. 

  304. <section>
    305. 

  305. <ul class="blockList">
    306. 

  306. <li class="blockList"><a id="constructor.detail">
    307. 

  307. <!--   -->
    308. 

  308. </a>
    309. 

  309. <h3>Constructor Detail</h3>
    310. 

  310. <a id="&lt;init&gt;()">
    311. 

  311. <!--   -->
    312. 

  312. </a>
    313. 

  313. <ul class="blockListLast">
    314. 

  314. <li class="blockList">
    315. 

  315. <h4>ParamUtils</h4>
    316. 

  316. <pre>public&nbsp;ParamUtils()</pre>
    317. 

  317. </li>
    318. 

  318. </ul>
    319. 

  319. </li>
    320. 

  320. </ul>
    321. 

  321. </section>
    322. 

  322. <!-- ============ METHOD DETAIL ========== -->
    323. 

  323. <section>
    324. 

  324. <ul class="blockList">
    325. 

  325. <li class="blockList"><a id="method.detail">
    326. 

  326. <!--   -->
    327. 

  327. </a>
    328. 

  328. <h3>Method Detail</h3>
    329. 

  329. <a id="getTypeErrorMsg()">
    330. 

  330. <!--   -->
    331. 

  331. </a>
    332. 

  332. <ul class="blockList">
    333. 

  333. <li class="blockList">
    334. 

  334. <h4>getTypeErrorMsg</h4>
    335. 

  335. <pre class="methodSignature">public static&nbsp;java.util.HashMap&lt;io.milvus.grpc.DataType,&#8203;java.lang.String&gt;&nbsp;getTypeErrorMsg()</pre>
    336. 

  336. </li>
    337. 

  337. </ul>
    338. 

  338. <a id="CheckNullEmptyString(java.lang.String,java.lang.String)">
    339. 

  339. <!--   -->
    340. 

  340. </a>
    341. 

  341. <ul class="blockList">
    342. 

  342. <li class="blockList">
    343. 

  343. <h4>CheckNullEmptyString</h4>
    344. 

  344. <pre class="methodSignature">public static&nbsp;void&nbsp;CheckNullEmptyString&#8203;(java.lang.String&nbsp;target,
    345. 

  345.                                         java.lang.String&nbsp;name)
    346. 

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

  347. <div class="block">Checks if a string is empty or null.
    348. 

  348.  Throws <a href="../exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the string is empty of null.</div>
    349. 

  349. <dl>
    350. 

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

  351. <dd><code>target</code> - target string</dd>
    352. 

  352. <dd><code>name</code> - a name to describe this string</dd>
    353. 

  353. <dt><span class="throwsLabel">Throws:</span></dt>
    354. 

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

  355. </dl>
    356. 

  356. </li>
    357. 

  357. </ul>
    358. 

  358. <a id="CheckNullString(java.lang.String,java.lang.String)">
    359. 

  359. <!--   -->
    360. 

  360. </a>
    361. 

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

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

  363. <h4>CheckNullString</h4>
    364. 

  364. <pre class="methodSignature">public static&nbsp;void&nbsp;CheckNullString&#8203;(java.lang.String&nbsp;target,
    365. 

  365.                                    java.lang.String&nbsp;name)
    366. 

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

  367. <div class="block">Checks if a string is  null.
    368. 

  368.  Throws <a href="../exception/ParamException.html" title="class in io.milvus.exception"><code>ParamException</code></a> if the string is null.</div>
    369. 

  369. <dl>
    370. 

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

  371. <dd><code>target</code> - target string</dd>
    372. 

  372. <dd><code>name</code> - a name to describe this string</dd>
    373. 

  373. <dt><span class="throwsLabel">Throws:</span></dt>
    374. 

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

  375. </dl>
    376. 

  376. </li>
    377. 

  377. </ul>
    378. 

  378. <a id="IsFloatMetric(io.milvus.param.MetricType)">
    379. 

  379. <!--   -->
    380. 

  380. </a>
    381. 

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

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

  383. <h4>IsFloatMetric</h4>
    384. 

  384. <pre class="methodSignature">public static&nbsp;boolean&nbsp;IsFloatMetric&#8203;(<a href="MetricType.html" title="enum in io.milvus.param">MetricType</a>&nbsp;metric)</pre>
    385. 

  385. <div class="block">Checks if a metric is for float vector.</div>
    386. 

  386. <dl>
    387. 

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

  388. <dd><code>metric</code> - metric type</dd>
    389. 

  389. </dl>
    390. 

  390. </li>
    391. 

  391. </ul>
    392. 

  392. <a id="IsBinaryMetric(io.milvus.param.MetricType)">
    393. 

  393. <!--   -->
    394. 

  394. </a>
    395. 

  395. <ul class="blockList">
    396. 

  396. <li class="blockList">
    397. 

  397. <h4>IsBinaryMetric</h4>
    398. 

  398. <pre class="methodSignature">public static&nbsp;boolean&nbsp;IsBinaryMetric&#8203;(<a href="MetricType.html" title="enum in io.milvus.param">MetricType</a>&nbsp;metric)</pre>
    399. 

  399. <div class="block">Checks if a metric is for binary vector.</div>
    400. 

  400. <dl>
    401. 

  401. <dt><span class="paramLabel">Parameters:</span></dt>
    402. 

  402. <dd><code>metric</code> - metric type</dd>
    403. 

  403. </dl>
    404. 

  404. </li>
    405. 

  405. </ul>
    406. 

  406. <a id="IsVectorIndex(io.milvus.param.IndexType)">
    407. 

  407. <!--   -->
    408. 

  408. </a>
    409. 

  409. <ul class="blockList">
    410. 

  410. <li class="blockList">
    411. 

  411. <h4>IsVectorIndex</h4>
    412. 

  412. <pre class="methodSignature">public static&nbsp;boolean&nbsp;IsVectorIndex&#8203;(<a href="IndexType.html" title="enum in io.milvus.param">IndexType</a>&nbsp;idx)</pre>
    413. 

  413. <div class="block">Checks if an index type is for vector field.</div>
    414. 

  414. <dl>
    415. 

  415. <dt><span class="paramLabel">Parameters:</span></dt>
    416. 

  416. <dd><code>idx</code> - index type</dd>
    417. 

  417. </dl>
    418. 

  418. </li>
    419. 

  419. </ul>
    420. 

  420. <a id="VerifyIndexType(io.milvus.param.IndexType,io.milvus.grpc.DataType)">
    421. 

  421. <!--   -->
    422. 

  422. </a>
    423. 

  423. <ul class="blockList">
    424. 

  424. <li class="blockList">
    425. 

  425. <h4>VerifyIndexType</h4>
    426. 

  426. <pre class="methodSignature">public static&nbsp;boolean&nbsp;VerifyIndexType&#8203;(<a href="IndexType.html" title="enum in io.milvus.param">IndexType</a>&nbsp;indexType,
    427. 

  427.                                       io.milvus.grpc.DataType&nbsp;dataType)</pre>
    428. 

  428. <div class="block">Checks if an index type is matched with data type.</div>
    429. 

  429. <dl>
    430. 

  430. <dt><span class="paramLabel">Parameters:</span></dt>
    431. 

  431. <dd><code>indexType</code> - index type</dd>
    432. 

  432. <dd><code>dataType</code> - data type</dd>
    433. 

  433. </dl>
    434. 

  434. </li>
    435. 

  435. </ul>
    436. 

  436. <a id="convertSearchParam(io.milvus.param.dml.SearchParam)">
    437. 

  437. <!--   -->
    438. 

  438. </a>
    439. 

  439. <ul class="blockList">
    440. 

  440. <li class="blockList">
    441. 

  441. <h4>convertSearchParam</h4>
    442. 

  442. <pre class="methodSignature">public static&nbsp;io.milvus.grpc.SearchRequest&nbsp;convertSearchParam&#8203;(@NonNull
    443. 

  443.                                                               @NonNull <a href="dml/SearchParam.html" title="class in io.milvus.param.dml">SearchParam</a>&nbsp;requestParam)
    444. 

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

  445. <dl>
    446. 

  446. <dt><span class="throwsLabel">Throws:</span></dt>
    447. 

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

  448. </dl>
    449. 

  449. </li>
    450. 

  450. </ul>
    451. 

  451. <a id="convertQueryParam(io.milvus.param.dml.QueryParam)">
    452. 

  452. <!--   -->
    453. 

  453. </a>
    454. 

  454. <ul class="blockList">
    455. 

  455. <li class="blockList">
    456. 

  456. <h4>convertQueryParam</h4>
    457. 

  457. <pre class="methodSignature">public static&nbsp;io.milvus.grpc.QueryRequest&nbsp;convertQueryParam&#8203;(@NonNull
    458. 

  458.                                                             @NonNull <a href="dml/QueryParam.html" title="class in io.milvus.param.dml">QueryParam</a>&nbsp;requestParam)</pre>
    459. 

  459. </li>
    460. 

  460. </ul>
    461. 

  461. <a id="ConvertField(io.milvus.grpc.FieldSchema)">
    462. 

  462. <!--   -->
    463. 

  463. </a>
    464. 

  464. <ul class="blockList">
    465. 

  465. <li class="blockList">
    466. 

  466. <h4>ConvertField</h4>
    467. 

  467. <pre class="methodSignature">public static&nbsp;<a href="collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>&nbsp;ConvertField&#8203;(@NonNull
    468. 

  468.                                      @NonNull io.milvus.grpc.FieldSchema&nbsp;field)</pre>
    469. 

  469. <div class="block">Convert a grpc field schema to client field schema</div>
    470. 

  470. <dl>
    471. 

  471. <dt><span class="paramLabel">Parameters:</span></dt>
    472. 

  472. <dd><code>field</code> - FieldSchema object</dd>
    473. 

  473. <dt><span class="returnLabel">Returns:</span></dt>
    474. 

  474. <dd><a href="collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the field</dd>
    475. 

  475. </dl>
    476. 

  476. </li>
    477. 

  477. </ul>
    478. 

  478. <a id="ConvertField(io.milvus.param.collection.FieldType)">
    479. 

  479. <!--   -->
    480. 

  480. </a>
    481. 

  481. <ul class="blockList">
    482. 

  482. <li class="blockList">
    483. 

  483. <h4>ConvertField</h4>
    484. 

  484. <pre class="methodSignature">public static&nbsp;io.milvus.grpc.FieldSchema&nbsp;ConvertField&#8203;(@NonNull
    485. 

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

  486. <div class="block">Convert a client field schema to grpc field schema</div>
    487. 

  487. <dl>
    488. 

  488. <dt><span class="paramLabel">Parameters:</span></dt>
    489. 

  489. <dd><code>field</code> - <a href="collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> object</dd>
    490. 

  490. <dt><span class="returnLabel">Returns:</span></dt>
    491. 

  491. <dd><code>FieldSchema</code> schema of the field</dd>
    492. 

  492. </dl>
    493. 

  493. </li>
    494. 

  494. </ul>
    495. 

  495. <a id="AssembleKvPair(java.util.Map)">
    496. 

  496. <!--   -->
    497. 

  497. </a>
    498. 

  498. <ul class="blockListLast">
    499. 

  499. <li class="blockList">
    500. 

  500. <h4>AssembleKvPair</h4>
    501. 

  501. <pre class="methodSignature">public static&nbsp;java.util.List&lt;io.milvus.grpc.KeyValuePair&gt;&nbsp;AssembleKvPair&#8203;(java.util.Map&lt;java.lang.String,&#8203;java.lang.String&gt;&nbsp;sourceMap)</pre>
    502. 

  502. </li>
    503. 

  503. </ul>
    504. 

  504. </li>
    505. 

  505. </ul>
    506. 

  506. </section>
    507. 

  507. </li>
    508. 

  508. </ul>
    509. 

  509. </div>
    510. 

  510. </div>
    511. 

  511. </main>
    512. 

  512. <!-- ========= END OF CLASS DATA ========= -->
    513. 

  513. <footer role="contentinfo">
    514. 

  514. <nav role="navigation">
    515. 

  515. <!-- ======= START OF BOTTOM NAVBAR ====== -->
    516. 

  516. <div class="bottomNav"><a id="navbar.bottom">
    517. 

  517. <!--   -->
    518. 

  518. </a>
    519. 

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

  520. <a id="navbar.bottom.firstrow">
    521. 

  521. <!--   -->
    522. 

  522. </a>
    523. 

  523. <ul class="navList" title="Navigation">
    524. 

  524. <li><a href="../../../index.html">Overview</a></li>
    525. 

  525. <li><a href="package-summary.html">Package</a></li>
    526. 

  526. <li class="navBarCell1Rev">Class</li>
    527. 

  527. <li><a href="package-tree.html">Tree</a></li>
    528. 

  528. <li><a href="../../../deprecated-list.html">Deprecated</a></li>
    529. 

  529. <li><a href="../../../index-files/index-1.html">Index</a></li>
    530. 

  530. <li><a href="../../../help-doc.html">Help</a></li>
    531. 

  531. </ul>
    532. 

  532. </div>
    533. 

  533. <div class="subNav">
    534. 

  534. <ul class="navList" id="allclasses_navbar_bottom">
    535. 

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

  536. </ul>
    537. 

  537. <div>
    538. 

  538. <script type="text/javascript"><!--
    539. 

  539.   allClassesLink = document.getElementById("allclasses_navbar_bottom");
    540. 

  540.   if(window==top) {
    541. 

  541.     allClassesLink.style.display = "block";
    542. 

  542.   }
    543. 

  543.   else {
    544. 

  544.     allClassesLink.style.display = "none";
    545. 

  545.   }
    546. 

  546.   //-->
    547. 

  547. </script>
    548. 

  548. <noscript>
    549. 

  549. <div>JavaScript is disabled on your browser.</div>
    550. 

  550. </noscript>
    551. 

  551. </div>
    552. 

  552. <div>
    553. 

  553. <ul class="subNavList">
    554. 

  554. <li>Summary:&nbsp;</li>
    555. 

  555. <li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
    556. 

  556. <li>Field&nbsp;|&nbsp;</li>
    557. 

  557. <li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
    558. 

  558. <li><a href="#method.summary">Method</a></li>
    559. 

  559. </ul>
    560. 

  560. <ul class="subNavList">
    561. 

  561. <li>Detail:&nbsp;</li>
    562. 

  562. <li>Field&nbsp;|&nbsp;</li>
    563. 

  563. <li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
    564. 

  564. <li><a href="#method.detail">Method</a></li>
    565. 

  565. </ul>
    566. 

  566. </div>
    567. 

  567. <a id="skip.navbar.bottom">
    568. 

  568. <!--   -->
    569. 

  569. </a></div>
    570. 

  570. <!-- ======== END OF BOTTOM NAVBAR ======= -->
    571. 

  571. </nav>
    572. 

  572. </footer>
    573. 

  573. </body>
    574. 

  574. </html>
    575.