Package io.milvus.response

Class DescCollResponseWrapper

java.lang.Object
io.milvus.response.DescCollResponseWrapper
public class DescCollResponseWrapper extends Object
Util class to wrap response of describeCollection interface.

  • Constructor Details

  • Method Details

    • getCollectionName

      public String getCollectionName()
      Get name of the collection.
      Returns:
      String name of the collection

    • getDatabaseName

      public String getDatabaseName()
      Get database name of the collection.
      Returns:
      String name of the database

    • getCollectionDescription

      public String getCollectionDescription()
      Get description of the collection.
      Returns:
      String description of the collection

    • getCollectionID

      public long getCollectionID()
      Get internal id of the collection.
      Returns:
      long internal id of the collection

    • getShardNumber

      public int getShardNumber()
      Get shard number of the collection.
      Returns:
      int shard number of the collection

    • getConsistencyLevel

      public ConsistencyLevelEnum getConsistencyLevel()
      Get consistency level of the collection.
      Returns:
      ConsistencyLevelEnum consistency level of the collection

    • getCreatedUtcTimestamp

      public long getCreatedUtcTimestamp()
      Get utc timestamp when collection created.
      Returns:
      long utc timestamp when collection created

    • getAliases

      public List<String> getAliases()
      Get aliases of the collection.
      Returns:
      List of String, aliases of the collection

    • getFields

      public List<FieldType> getFields()
      Get schema of the collection's fields.
      Returns:
      List of FieldType, schema of the collection's fields

    • getFieldByName

      public FieldType getFieldByName(@NonNull @NonNull String fieldName)
      Get schema of a field by name. Return null if the field doesn't exist
      Parameters:
      fieldName - field name to get field description
      Returns:
      FieldType schema of the field

    • getEnableDynamicField

      @Deprecated public boolean getEnableDynamicField()
      Deprecated.

    • isDynamicFieldEnabled

      public boolean isDynamicFieldEnabled()
      Get whether the collection dynamic field is enabled
      Returns:
      boolean

    • getPartitionKeyField

      public FieldType getPartitionKeyField()
      Get the partition key field. Return null if the partition key field doesn't exist.
      Returns:
      FieldType schema of the partition key field

    • getPrimaryField

      public FieldType getPrimaryField()
      Get the primary key field. throw ParamException if the primary key field doesn't exist.
      Returns:
      FieldType schema of the primary key field

    • getVectorField

      @Deprecated public FieldType getVectorField()
      Deprecated.
      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
      Returns:
      FieldType schema of the vector key field

    • getVectorFields

      public List<FieldType> getVectorFields()
      Get all the vector key field. (Milvus supports multiple vector fields from v2.4)
      Returns:
      FieldType schema of the vector key field

    • getProperties

      public Map<String,String> getProperties()
      Get properties of the collection.
      Returns:
      List of String, aliases of the collection

    • getSchema

      public CollectionSchemaParam getSchema()
      Get the collection schema of collection
      Returns:
      CollectionSchemaParam schema of the collection

    • getResourceGroups

      public List<String> getResourceGroups()
      return collection resource groups
      Returns:
      resource group names

    • getReplicaNumber

      public int getReplicaNumber()
      return collection replica number
      Returns:
      replica number

    • toString

      public String toString()
      Construct a String by DescCollResponseWrapper instance.
      Overrides:
      toString in class Object
      Returns:
      String