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 Summary

Constructors

Constructor	Description
DescCollResponseWrapper(@NonNull DescribeCollectionResponse response)

Method Summary

Modifier and Type	Method	Description
List<String>	getAliases()	Get aliases of the collection.
String	getCollectionDescription()	Get description of the collection.
long	getCollectionID()	Get internal id of the collection.
String	getCollectionName()	Get name of the collection.
long	getCreatedUtcTimestamp()	Get utc timestamp when collection created.
boolean	getEnableDynamicField()
FieldType	getFieldByName(@NonNull String fieldName)	Get schema of a field by name.
List<FieldType>	getFields()	Get schema of the collection's fields.
FieldType	getPartitionKeyField()	Get the partition key field.
FieldType	getPrimaryField()	Get the primary key field.
Map<String,String>	getProperties()	Get properties of the collection.
CollectionSchemaParam	getSchema()	Get the collection schema of collection
int	getShardNumber()	Get shard number of the collection.
FieldType	getVectorField()	Deprecated.
List<FieldType>	getVectorFields()	Get all the vector key field.
boolean	isDynamicFieldEnabled()	Get whether the collection dynamic field is enabled
String	toString()	Construct a String by DescCollResponseWrapper instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DescCollResponseWrapper

public DescCollResponseWrapper(@NonNull
                               @NonNull DescribeCollectionResponse response)

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

@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

toString

public String toString()

Construct a String by DescCollResponseWrapper instance.

Overrides:

toString in class Object

Returns:

String