Package io.milvus.response

Class DescCollResponseWrapper

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

    • Constructor Detail

      • DescCollResponseWrapper

        public DescCollResponseWrapper​(@NonNull
                               @NonNull io.milvus.grpc.DescribeCollectionResponse response)

    • Method Detail

      • getEnableDynamicField

        public boolean getEnableDynamicField()

      • getCollectionName

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

      • getCollectionDescription

        public java.lang.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 java.util.List<java.lang.String> getAliases()
        Get aliases of the collection.
        Returns:
        List of String, aliases of the collection

      • getFields

        public java.util.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 java.lang.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

        @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 java.util.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 java.util.Map<java.lang.String,​java.lang.String> getProperties()
        Get properties of the collection.
        Returns:
        List of String, aliases of the collection

      • toString

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