Package io.milvus.response

Class DescIndexResponseWrapper

java.lang.Object

io.milvus.response.DescIndexResponseWrapper

public class DescIndexResponseWrapper
extends Object

Util class to wrap response of describeIndex interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	DescIndexResponseWrapper.IndexDesc	Internal-use class to wrap response of describeIndex interface.

Constructor Summary

Constructors

Constructor	Description
DescIndexResponseWrapper(@NonNull DescribeIndexResponse response)

Method Summary

Modifier and Type	Method	Description
DescIndexResponseWrapper.IndexDesc	getIndexDescByFieldName(@NonNull String fieldName)	Get index description by field name.
DescIndexResponseWrapper.IndexDesc	getIndexDescByIndexName(@NonNull String indexName)	Get index description by index name.
List<DescIndexResponseWrapper.IndexDesc>	getIndexDescriptions()	Get index description of fields.

Methods inherited from class java.lang.Object

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

Constructor Details

DescIndexResponseWrapper

public DescIndexResponseWrapper(@NonNull
 @NonNull DescribeIndexResponse response)

Method Details

getIndexDescriptions

public List<DescIndexResponseWrapper.IndexDesc> getIndexDescriptions()

Get index description of fields.

Returns:

List of IndexDesc, index description of fields

getIndexDescByFieldName

public DescIndexResponseWrapper.IndexDesc getIndexDescByFieldName(@NonNull
 @NonNull String fieldName)

Get index description by field name. Return null if the field doesn't exist

Parameters:

fieldName - field name to get index description

Returns:

DescIndexResponseWrapper.IndexDesc description of the index

getIndexDescByIndexName

public DescIndexResponseWrapper.IndexDesc getIndexDescByIndexName(@NonNull
 @NonNull String indexName)

Get index description by index name. Return null if the index doesn't exist

Parameters:

indexName - index name to get index description

Returns:

DescIndexResponseWrapper.IndexDesc description of the index