Package io.milvus.response

Class QueryResultsWrapper

java.lang.Object

io.milvus.response.QueryResultsWrapper

public class QueryResultsWrapper
extends Object

Utility class to wrap response of query interface.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	QueryResultsWrapper.RowRecord	Internal-use class to wrap response of query interface.

Constructor Summary

Constructors

Constructor	Description
QueryResultsWrapper(@NonNull QueryResults results)

Method Summary

Modifier and Type	Method	Description
FieldDataWrapper	getDynamicWrapper()	Get the dynamic field.
FieldDataWrapper	getFieldWrapper(@NonNull String fieldName)	Gets FieldDataWrapper for a field.
long	getRowCount()	Gets the row count of a query result.
QueryResultsWrapper.RowRecord	getRowRecord(long index)	Gets a row record from query result.
List<QueryResultsWrapper.RowRecord>	getRowRecords()	Gets row records list from query result.

Methods inherited from class java.lang.Object

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

Constructor Detail

QueryResultsWrapper

public QueryResultsWrapper(@NonNull
                           @NonNull QueryResults results)

Method Detail

getFieldWrapper

public FieldDataWrapper getFieldWrapper(@NonNull
                                        @NonNull String fieldName)
                                 throws ParamException

Gets FieldDataWrapper for a field. Throws ParamException if the field doesn't exist.

Parameters:

fieldName - field name to get output data

Returns:

FieldDataWrapper

Throws:

ParamException

getDynamicWrapper

public FieldDataWrapper getDynamicWrapper()
                                   throws ParamException

Get the dynamic field. Only available when a collection's dynamic field is enabled. Throws ParamException if the dynamic field doesn't exist.

Returns:

FieldDataWrapper

Throws:

ParamException

getRowCount

public long getRowCount()

Gets the row count of a query result.

Returns:

long row count of the query result

getRowRecord

public QueryResultsWrapper.RowRecord getRowRecord(long index)
                                           throws ParamException

Gets a row record from query result. Throws ParamException if the index is illegal.

Returns:

RowRecord a row record of the query result

Throws:

ParamException

getRowRecords

public List<QueryResultsWrapper.RowRecord> getRowRecords()

Gets row records list from query result.

Returns:

List a row records list of the query result