Package io.milvus.response

Class DescCollResponseWrapper

  • public class DescCollResponseWrapper
extends Object
    Util class to wrap response of describeCollection interface.

    • Method Detail

      • getEnableDynamicField

        public boolean getEnableDynamicField()

      • getCollectionName

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

      • 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

      • 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

      • 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

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