123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687 |
- <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
- <!-- NewPage -->
- <html lang="en">
- <head>
- <!-- Generated by javadoc (1.8.0_402-402) on Fri Oct 18 12:22:14 CST 2024 -->
- <title>DescCollResponseWrapper</title>
- <meta name="date" content="2024-10-18">
- <link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
- <script type="text/javascript" src="../../../script.js"></script>
- </head>
- <body>
- <script type="text/javascript"><!--
- try {
- if (location.href.indexOf('is-external=true') == -1) {
- parent.document.title="DescCollResponseWrapper";
- }
- }
- catch(err) {
- }
- //-->
- var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":42,"i8":10,"i9":10,"i10":10,"i11":10,"i12":10,"i13":10,"i14":10,"i15":10,"i16":10,"i17":42,"i18":10,"i19":10,"i20":10};
- var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
- var altColor = "altColor";
- var rowColor = "rowColor";
- var tableTab = "tableTab";
- var activeTableTab = "activeTableTab";
- </script>
- <noscript>
- <div>JavaScript is disabled on your browser.</div>
- </noscript>
- <!-- ========= START OF TOP NAVBAR ======= -->
- <div class="topNav"><a name="navbar.top">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.top.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../io/milvus/response/BulkInsertResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../io/milvus/response/DescDBResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?io/milvus/response/DescCollResponseWrapper.html" target="_top">Frames</a></li>
- <li><a href="DescCollResponseWrapper.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_top">
- <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_top");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.top">
- <!-- -->
- </a></div>
- <!-- ========= END OF TOP NAVBAR ========= -->
- <!-- ======== START OF CLASS DATA ======== -->
- <div class="header">
- <div class="subTitle">io.milvus.response</div>
- <h2 title="Class DescCollResponseWrapper" class="title">Class DescCollResponseWrapper</h2>
- </div>
- <div class="contentContainer">
- <ul class="inheritance">
- <li>java.lang.Object</li>
- <li>
- <ul class="inheritance">
- <li>io.milvus.response.DescCollResponseWrapper</li>
- </ul>
- </li>
- </ul>
- <div class="description">
- <ul class="blockList">
- <li class="blockList">
- <hr>
- <br>
- <pre>public class <span class="typeNameLabel">DescCollResponseWrapper</span>
- extends java.lang.Object</pre>
- <div class="block">Util class to wrap response of <code>describeCollection</code> interface.</div>
- </li>
- </ul>
- </div>
- <div class="summary">
- <ul class="blockList">
- <li class="blockList">
- <!-- ======== CONSTRUCTOR SUMMARY ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.summary">
- <!-- -->
- </a>
- <h3>Constructor Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
- <caption><span>Constructors</span><span class="tabEnd"> </span></caption>
- <tr>
- <th class="colOne" scope="col">Constructor and Description</th>
- </tr>
- <tr class="altColor">
- <td class="colOne"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#DescCollResponseWrapper-io.milvus.grpc.DescribeCollectionResponse-">DescCollResponseWrapper</a></span>(@NonNull io.milvus.grpc.DescribeCollectionResponse response)</code> </td>
- </tr>
- </table>
- </li>
- </ul>
- <!-- ========== METHOD SUMMARY =========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.summary">
- <!-- -->
- </a>
- <h3>Method Summary</h3>
- <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
- <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd"> </span></span></caption>
- <tr>
- <th class="colFirst" scope="col">Modifier and Type</th>
- <th class="colLast" scope="col">Method and Description</th>
- </tr>
- <tr id="i0" class="altColor">
- <td class="colFirst"><code>java.util.List<java.lang.String></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getAliases--">getAliases</a></span>()</code>
- <div class="block">Get aliases of the collection.</div>
- </td>
- </tr>
- <tr id="i1" class="rowColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getCollectionDescription--">getCollectionDescription</a></span>()</code>
- <div class="block">Get description of the collection.</div>
- </td>
- </tr>
- <tr id="i2" class="altColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getCollectionID--">getCollectionID</a></span>()</code>
- <div class="block">Get internal id of the collection.</div>
- </td>
- </tr>
- <tr id="i3" class="rowColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getCollectionName--">getCollectionName</a></span>()</code>
- <div class="block">Get name of the collection.</div>
- </td>
- </tr>
- <tr id="i4" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/common/clientenum/ConsistencyLevelEnum.html" title="enum in io.milvus.common.clientenum">ConsistencyLevelEnum</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getConsistencyLevel--">getConsistencyLevel</a></span>()</code>
- <div class="block">Get consistency level of the collection.</div>
- </td>
- </tr>
- <tr id="i5" class="rowColor">
- <td class="colFirst"><code>long</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getCreatedUtcTimestamp--">getCreatedUtcTimestamp</a></span>()</code>
- <div class="block">Get utc timestamp when collection created.</div>
- </td>
- </tr>
- <tr id="i6" class="altColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getDatabaseName--">getDatabaseName</a></span>()</code>
- <div class="block">Get database name of the collection.</div>
- </td>
- </tr>
- <tr id="i7" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getEnableDynamicField--">getEnableDynamicField</a></span>()</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- </td>
- </tr>
- <tr id="i8" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getFieldByName-java.lang.String-">getFieldByName</a></span>(@NonNull java.lang.String fieldName)</code>
- <div class="block">Get schema of a field by name.</div>
- </td>
- </tr>
- <tr id="i9" class="rowColor">
- <td class="colFirst"><code>java.util.List<<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getFields--">getFields</a></span>()</code>
- <div class="block">Get schema of the collection's fields.</div>
- </td>
- </tr>
- <tr id="i10" class="altColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getPartitionKeyField--">getPartitionKeyField</a></span>()</code>
- <div class="block">Get the partition key field.</div>
- </td>
- </tr>
- <tr id="i11" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getPrimaryField--">getPrimaryField</a></span>()</code>
- <div class="block">Get the primary key field.</div>
- </td>
- </tr>
- <tr id="i12" class="altColor">
- <td class="colFirst"><code>java.util.Map<java.lang.String,java.lang.String></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getProperties--">getProperties</a></span>()</code>
- <div class="block">Get properties of the collection.</div>
- </td>
- </tr>
- <tr id="i13" class="rowColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getReplicaNumber--">getReplicaNumber</a></span>()</code>
- <div class="block">return collection replica number</div>
- </td>
- </tr>
- <tr id="i14" class="altColor">
- <td class="colFirst"><code>java.util.List<java.lang.String></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getResourceGroups--">getResourceGroups</a></span>()</code>
- <div class="block">return collection resource groups</div>
- </td>
- </tr>
- <tr id="i15" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/collection/CollectionSchemaParam.html" title="class in io.milvus.param.collection">CollectionSchemaParam</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getSchema--">getSchema</a></span>()</code>
- <div class="block">Get the collection schema of collection</div>
- </td>
- </tr>
- <tr id="i16" class="altColor">
- <td class="colFirst"><code>int</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getShardNumber--">getShardNumber</a></span>()</code>
- <div class="block">Get shard number of the collection.</div>
- </td>
- </tr>
- <tr id="i17" class="rowColor">
- <td class="colFirst"><code><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getVectorField--">getVectorField</a></span>()</code>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- </td>
- </tr>
- <tr id="i18" class="altColor">
- <td class="colFirst"><code>java.util.List<<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>></code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#getVectorFields--">getVectorFields</a></span>()</code>
- <div class="block">Get all the vector key field.</div>
- </td>
- </tr>
- <tr id="i19" class="rowColor">
- <td class="colFirst"><code>boolean</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#isDynamicFieldEnabled--">isDynamicFieldEnabled</a></span>()</code>
- <div class="block">Get whether the collection dynamic field is enabled</div>
- </td>
- </tr>
- <tr id="i20" class="altColor">
- <td class="colFirst"><code>java.lang.String</code></td>
- <td class="colLast"><code><span class="memberNameLink"><a href="../../../io/milvus/response/DescCollResponseWrapper.html#toString--">toString</a></span>()</code>
- <div class="block">Construct a <code>String</code> by <a href="../../../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response"><code>DescCollResponseWrapper</code></a> instance.</div>
- </td>
- </tr>
- </table>
- <ul class="blockList">
- <li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
- <!-- -->
- </a>
- <h3>Methods inherited from class java.lang.Object</h3>
- <code>equals, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- <div class="details">
- <ul class="blockList">
- <li class="blockList">
- <!-- ========= CONSTRUCTOR DETAIL ======== -->
- <ul class="blockList">
- <li class="blockList"><a name="constructor.detail">
- <!-- -->
- </a>
- <h3>Constructor Detail</h3>
- <a name="DescCollResponseWrapper-io.milvus.grpc.DescribeCollectionResponse-">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>DescCollResponseWrapper</h4>
- <pre>public DescCollResponseWrapper(@NonNull
- @NonNull io.milvus.grpc.DescribeCollectionResponse response)</pre>
- </li>
- </ul>
- </li>
- </ul>
- <!-- ============ METHOD DETAIL ========== -->
- <ul class="blockList">
- <li class="blockList"><a name="method.detail">
- <!-- -->
- </a>
- <h3>Method Detail</h3>
- <a name="getCollectionName--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCollectionName</h4>
- <pre>public java.lang.String getCollectionName()</pre>
- <div class="block">Get name of the collection.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>String</code> name of the collection</dd>
- </dl>
- </li>
- </ul>
- <a name="getDatabaseName--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getDatabaseName</h4>
- <pre>public java.lang.String getDatabaseName()</pre>
- <div class="block">Get database name of the collection.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>String</code> name of the database</dd>
- </dl>
- </li>
- </ul>
- <a name="getCollectionDescription--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCollectionDescription</h4>
- <pre>public java.lang.String getCollectionDescription()</pre>
- <div class="block">Get description of the collection.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>String</code> description of the collection</dd>
- </dl>
- </li>
- </ul>
- <a name="getCollectionID--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCollectionID</h4>
- <pre>public long getCollectionID()</pre>
- <div class="block">Get internal id of the collection.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>long</code> internal id of the collection</dd>
- </dl>
- </li>
- </ul>
- <a name="getShardNumber--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getShardNumber</h4>
- <pre>public int getShardNumber()</pre>
- <div class="block">Get shard number of the collection.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>int</code> shard number of the collection</dd>
- </dl>
- </li>
- </ul>
- <a name="getConsistencyLevel--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getConsistencyLevel</h4>
- <pre>public <a href="../../../io/milvus/common/clientenum/ConsistencyLevelEnum.html" title="enum in io.milvus.common.clientenum">ConsistencyLevelEnum</a> getConsistencyLevel()</pre>
- <div class="block">Get consistency level of the collection.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>ConsistencyLevelEnum</code> consistency level of the collection</dd>
- </dl>
- </li>
- </ul>
- <a name="getCreatedUtcTimestamp--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getCreatedUtcTimestamp</h4>
- <pre>public long getCreatedUtcTimestamp()</pre>
- <div class="block">Get utc timestamp when collection created.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>long</code> utc timestamp when collection created</dd>
- </dl>
- </li>
- </ul>
- <a name="getAliases--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getAliases</h4>
- <pre>public java.util.List<java.lang.String> getAliases()</pre>
- <div class="block">Get aliases of the collection.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>List of String, aliases of the collection</dd>
- </dl>
- </li>
- </ul>
- <a name="getFields--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFields</h4>
- <pre>public java.util.List<<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>> getFields()</pre>
- <div class="block">Get schema of the collection's fields.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>List of FieldType, schema of the collection's fields</dd>
- </dl>
- </li>
- </ul>
- <a name="getFieldByName-java.lang.String-">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getFieldByName</h4>
- <pre>public <a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a> getFieldByName(@NonNull
- @NonNull java.lang.String fieldName)</pre>
- <div class="block">Get schema of a field by name.
- Return null if the field doesn't exist</div>
- <dl>
- <dt><span class="paramLabel">Parameters:</span></dt>
- <dd><code>fieldName</code> - field name to get field description</dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the field</dd>
- </dl>
- </li>
- </ul>
- <a name="getEnableDynamicField--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getEnableDynamicField</h4>
- <pre>@Deprecated
- public boolean getEnableDynamicField()</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- </li>
- </ul>
- <a name="isDynamicFieldEnabled--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>isDynamicFieldEnabled</h4>
- <pre>public boolean isDynamicFieldEnabled()</pre>
- <div class="block">Get whether the collection dynamic field is enabled</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>boolean</dd>
- </dl>
- </li>
- </ul>
- <a name="getPartitionKeyField--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPartitionKeyField</h4>
- <pre>public <a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a> getPartitionKeyField()</pre>
- <div class="block">Get the partition key field.
- Return null if the partition key field doesn't exist.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the partition key field</dd>
- </dl>
- </li>
- </ul>
- <a name="getPrimaryField--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getPrimaryField</h4>
- <pre>public <a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a> getPrimaryField()</pre>
- <div class="block">Get the primary key field.
- throw ParamException if the primary key field doesn't exist.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the primary key field</dd>
- </dl>
- </li>
- </ul>
- <a name="getVectorField--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getVectorField</h4>
- <pre>@Deprecated
- public <a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a> getVectorField()</pre>
- <div class="block"><span class="deprecatedLabel">Deprecated.</span> </div>
- <div class="block">Get the vector key field.
- throw ParamException if the vector key field doesn't exist.
- This method is deprecated since Milvus supports multiple vector fields from v2.4</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the vector key field</dd>
- </dl>
- </li>
- </ul>
- <a name="getVectorFields--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getVectorFields</h4>
- <pre>public java.util.List<<a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection">FieldType</a>> getVectorFields()</pre>
- <div class="block">Get all the vector key field. (Milvus supports multiple vector fields from v2.4)</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><a href="../../../io/milvus/param/collection/FieldType.html" title="class in io.milvus.param.collection"><code>FieldType</code></a> schema of the vector key field</dd>
- </dl>
- </li>
- </ul>
- <a name="getProperties--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getProperties</h4>
- <pre>public java.util.Map<java.lang.String,java.lang.String> getProperties()</pre>
- <div class="block">Get properties of the collection.</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>List of String, aliases of the collection</dd>
- </dl>
- </li>
- </ul>
- <a name="getSchema--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getSchema</h4>
- <pre>public <a href="../../../io/milvus/param/collection/CollectionSchemaParam.html" title="class in io.milvus.param.collection">CollectionSchemaParam</a> getSchema()</pre>
- <div class="block">Get the collection schema of collection</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><a href="../../../io/milvus/param/collection/CollectionSchemaParam.html" title="class in io.milvus.param.collection"><code>CollectionSchemaParam</code></a> schema of the collection</dd>
- </dl>
- </li>
- </ul>
- <a name="getResourceGroups--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getResourceGroups</h4>
- <pre>public java.util.List<java.lang.String> getResourceGroups()</pre>
- <div class="block">return collection resource groups</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>resource group names</dd>
- </dl>
- </li>
- </ul>
- <a name="getReplicaNumber--">
- <!-- -->
- </a>
- <ul class="blockList">
- <li class="blockList">
- <h4>getReplicaNumber</h4>
- <pre>public int getReplicaNumber()</pre>
- <div class="block">return collection replica number</div>
- <dl>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd>replica number</dd>
- </dl>
- </li>
- </ul>
- <a name="toString--">
- <!-- -->
- </a>
- <ul class="blockListLast">
- <li class="blockList">
- <h4>toString</h4>
- <pre>public java.lang.String toString()</pre>
- <div class="block">Construct a <code>String</code> by <a href="../../../io/milvus/response/DescCollResponseWrapper.html" title="class in io.milvus.response"><code>DescCollResponseWrapper</code></a> instance.</div>
- <dl>
- <dt><span class="overrideSpecifyLabel">Overrides:</span></dt>
- <dd><code>toString</code> in class <code>java.lang.Object</code></dd>
- <dt><span class="returnLabel">Returns:</span></dt>
- <dd><code>String</code></dd>
- </dl>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </div>
- </div>
- <!-- ========= END OF CLASS DATA ========= -->
- <!-- ======= START OF BOTTOM NAVBAR ====== -->
- <div class="bottomNav"><a name="navbar.bottom">
- <!-- -->
- </a>
- <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
- <a name="navbar.bottom.firstrow">
- <!-- -->
- </a>
- <ul class="navList" title="Navigation">
- <li><a href="../../../overview-summary.html">Overview</a></li>
- <li><a href="package-summary.html">Package</a></li>
- <li class="navBarCell1Rev">Class</li>
- <li><a href="package-tree.html">Tree</a></li>
- <li><a href="../../../deprecated-list.html">Deprecated</a></li>
- <li><a href="../../../index-files/index-1.html">Index</a></li>
- <li><a href="../../../help-doc.html">Help</a></li>
- </ul>
- </div>
- <div class="subNav">
- <ul class="navList">
- <li><a href="../../../io/milvus/response/BulkInsertResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Prev Class</span></a></li>
- <li><a href="../../../io/milvus/response/DescDBResponseWrapper.html" title="class in io.milvus.response"><span class="typeNameLink">Next Class</span></a></li>
- </ul>
- <ul class="navList">
- <li><a href="../../../index.html?io/milvus/response/DescCollResponseWrapper.html" target="_top">Frames</a></li>
- <li><a href="DescCollResponseWrapper.html" target="_top">No Frames</a></li>
- </ul>
- <ul class="navList" id="allclasses_navbar_bottom">
- <li><a href="../../../allclasses-noframe.html">All Classes</a></li>
- </ul>
- <div>
- <script type="text/javascript"><!--
- allClassesLink = document.getElementById("allclasses_navbar_bottom");
- if(window==top) {
- allClassesLink.style.display = "block";
- }
- else {
- allClassesLink.style.display = "none";
- }
- //-->
- </script>
- </div>
- <div>
- <ul class="subNavList">
- <li>Summary: </li>
- <li>Nested | </li>
- <li>Field | </li>
- <li><a href="#constructor.summary">Constr</a> | </li>
- <li><a href="#method.summary">Method</a></li>
- </ul>
- <ul class="subNavList">
- <li>Detail: </li>
- <li>Field | </li>
- <li><a href="#constructor.detail">Constr</a> | </li>
- <li><a href="#method.detail">Method</a></li>
- </ul>
- </div>
- <a name="skip.navbar.bottom">
- <!-- -->
- </a></div>
- <!-- ======== END OF BOTTOM NAVBAR ======= -->
- </body>
- </html>
|