java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - io.milvus.grpc.SearchParam

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SearchParamOrBuilder, Serializable
```
public final class SearchParam
extends com.google.protobuf.GeneratedMessageV3
implements SearchParamOrBuilder
```
```
 @brief Params for searching vector
 
```
Protobuf type milvus.grpc.SearchParam
See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class SearchParam.Builder
@brief Params for searching vector
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`COLLECTION_NAME_FIELD_NUMBER`
`static int`	`EXTRA_PARAMS_FIELD_NUMBER`
`static int`	`PARTITION_TAG_ARRAY_FIELD_NUMBER`
`static int`	`QUERY_RECORD_ARRAY_FIELD_NUMBER`
`static int`	`TOPK_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`String`	`getCollectionName()`	`string collection_name = 1;`
`com.google.protobuf.ByteString`	`getCollectionNameBytes()`	`string collection_name = 1;`
`static SearchParam`	`getDefaultInstance()`
`SearchParam`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`KeyValuePair`	`getExtraParams(int index)`	`repeated .milvus.grpc.KeyValuePair extra_params = 5;`
`int`	`getExtraParamsCount()`	`repeated .milvus.grpc.KeyValuePair extra_params = 5;`
`List<KeyValuePair>`	`getExtraParamsList()`	`repeated .milvus.grpc.KeyValuePair extra_params = 5;`
`KeyValuePairOrBuilder`	`getExtraParamsOrBuilder(int index)`	`repeated .milvus.grpc.KeyValuePair extra_params = 5;`
`List<? extends KeyValuePairOrBuilder>`	`getExtraParamsOrBuilderList()`	`repeated .milvus.grpc.KeyValuePair extra_params = 5;`
`com.google.protobuf.Parser<SearchParam>`	`getParserForType()`
`String`	`getPartitionTagArray(int index)`	`repeated string partition_tag_array = 2;`
`com.google.protobuf.ByteString`	`getPartitionTagArrayBytes(int index)`	`repeated string partition_tag_array = 2;`
`int`	`getPartitionTagArrayCount()`	`repeated string partition_tag_array = 2;`
`com.google.protobuf.ProtocolStringList`	`getPartitionTagArrayList()`	`repeated string partition_tag_array = 2;`
`RowRecord`	`getQueryRecordArray(int index)`	`repeated .milvus.grpc.RowRecord query_record_array = 3;`
`int`	`getQueryRecordArrayCount()`	`repeated .milvus.grpc.RowRecord query_record_array = 3;`
`List<RowRecord>`	`getQueryRecordArrayList()`	`repeated .milvus.grpc.RowRecord query_record_array = 3;`
`RowRecordOrBuilder`	`getQueryRecordArrayOrBuilder(int index)`	`repeated .milvus.grpc.RowRecord query_record_array = 3;`
`List<? extends RowRecordOrBuilder>`	`getQueryRecordArrayOrBuilderList()`	`repeated .milvus.grpc.RowRecord query_record_array = 3;`
`int`	`getSerializedSize()`
`long`	`getTopk()`	`int64 topk = 4;`
`com.google.protobuf.UnknownFieldSet`	`getUnknownFields()`
`int`	`hashCode()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`static SearchParam.Builder`	`newBuilder()`
`static SearchParam.Builder`	`newBuilder(SearchParam prototype)`
`SearchParam.Builder`	`newBuilderForType()`
`protected SearchParam.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static SearchParam`	`parseDelimitedFrom(InputStream input)`
`static SearchParam`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchParam`	`parseFrom(byte[] data)`
`static SearchParam`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchParam`	`parseFrom(com.google.protobuf.ByteString data)`
`static SearchParam`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchParam`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static SearchParam`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchParam`	`parseFrom(InputStream input)`
`static SearchParam`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static SearchParam`	`parseFrom(ByteBuffer data)`
`static SearchParam`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<SearchParam>`	`parser()`
`SearchParam.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

- Field Detail
  - COLLECTION_NAME_FIELD_NUMBER
```
public static final int COLLECTION_NAME_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - PARTITION_TAG_ARRAY_FIELD_NUMBER
```
public static final int PARTITION_TAG_ARRAY_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - QUERY_RECORD_ARRAY_FIELD_NUMBER
```
public static final int QUERY_RECORD_ARRAY_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - TOPK_FIELD_NUMBER
```
public static final int TOPK_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
  - EXTRA_PARAMS_FIELD_NUMBER
```
public static final int EXTRA_PARAMS_FIELD_NUMBER
```
    See Also:
    
    Constant Field Values
- Method Detail
  - newInstance
```
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
```
    Overrides:
    
    newInstance in class com.google.protobuf.GeneratedMessageV3
  - getUnknownFields
```
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
```
    Specified by:
    
    getUnknownFields in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getUnknownFields in class com.google.protobuf.GeneratedMessageV3
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3
  - getCollectionName
```
public String getCollectionName()
```
    string collection_name = 1;
    
    Specified by:
    
    getCollectionName in interface SearchParamOrBuilder
    
    Returns:
    
    The collectionName.
  - getCollectionNameBytes
```
public com.google.protobuf.ByteString getCollectionNameBytes()
```
    string collection_name = 1;
    
    Specified by:
    
    getCollectionNameBytes in interface SearchParamOrBuilder
    
    Returns:
    
    The bytes for collectionName.
  - getPartitionTagArrayList
```
public com.google.protobuf.ProtocolStringList getPartitionTagArrayList()
```
    repeated string partition_tag_array = 2;
    
    Specified by:
    
    getPartitionTagArrayList in interface SearchParamOrBuilder
    
    Returns:
    
    A list containing the partitionTagArray.
  - getPartitionTagArrayCount
```
public int getPartitionTagArrayCount()
```
    repeated string partition_tag_array = 2;
    
    Specified by:
    
    getPartitionTagArrayCount in interface SearchParamOrBuilder
    
    Returns:
    
    The count of partitionTagArray.
  - getPartitionTagArray
```
public String getPartitionTagArray(int index)
```
    repeated string partition_tag_array = 2;
    
    Specified by:
    
    getPartitionTagArray in interface SearchParamOrBuilder
    
    Parameters:
    
    index - The index of the element to return.
    
    Returns:
    
    The partitionTagArray at the given index.
  - getPartitionTagArrayBytes
```
public com.google.protobuf.ByteString getPartitionTagArrayBytes(int index)
```
    repeated string partition_tag_array = 2;
    
    Specified by:
    
    getPartitionTagArrayBytes in interface SearchParamOrBuilder
    
    Parameters:
    
    index - The index of the value to return.
    
    Returns:
    
    The bytes of the partitionTagArray at the given index.
  - getQueryRecordArrayList
```
public List<RowRecord> getQueryRecordArrayList()
```
    repeated .milvus.grpc.RowRecord query_record_array = 3;
    
    Specified by:
    
    getQueryRecordArrayList in interface SearchParamOrBuilder
  - getQueryRecordArrayOrBuilderList
```
public List<? extends RowRecordOrBuilder> getQueryRecordArrayOrBuilderList()
```
    repeated .milvus.grpc.RowRecord query_record_array = 3;
    
    Specified by:
    
    getQueryRecordArrayOrBuilderList in interface SearchParamOrBuilder
  - getQueryRecordArrayCount
```
public int getQueryRecordArrayCount()
```
    repeated .milvus.grpc.RowRecord query_record_array = 3;
    
    Specified by:
    
    getQueryRecordArrayCount in interface SearchParamOrBuilder
  - getQueryRecordArray
```
public RowRecord getQueryRecordArray(int index)
```
    repeated .milvus.grpc.RowRecord query_record_array = 3;
    
    Specified by:
    
    getQueryRecordArray in interface SearchParamOrBuilder
  - getQueryRecordArrayOrBuilder
```
public RowRecordOrBuilder getQueryRecordArrayOrBuilder(int index)
```
    repeated .milvus.grpc.RowRecord query_record_array = 3;
    
    Specified by:
    
    getQueryRecordArrayOrBuilder in interface SearchParamOrBuilder
  - getTopk
```
public long getTopk()
```
    int64 topk = 4;
    
    Specified by:
    
    getTopk in interface SearchParamOrBuilder
    
    Returns:
    
    The topk.
  - getExtraParamsList
```
public List<KeyValuePair> getExtraParamsList()
```
    repeated .milvus.grpc.KeyValuePair extra_params = 5;
    
    Specified by:
    
    getExtraParamsList in interface SearchParamOrBuilder
  - getExtraParamsOrBuilderList
```
public List<? extends KeyValuePairOrBuilder> getExtraParamsOrBuilderList()
```
    repeated .milvus.grpc.KeyValuePair extra_params = 5;
    
    Specified by:
    
    getExtraParamsOrBuilderList in interface SearchParamOrBuilder
  - getExtraParamsCount
```
public int getExtraParamsCount()
```
    repeated .milvus.grpc.KeyValuePair extra_params = 5;
    
    Specified by:
    
    getExtraParamsCount in interface SearchParamOrBuilder
  - getExtraParams
```
public KeyValuePair getExtraParams(int index)
```
    repeated .milvus.grpc.KeyValuePair extra_params = 5;
    
    Specified by:
    
    getExtraParams in interface SearchParamOrBuilder
  - getExtraParamsOrBuilder
```
public KeyValuePairOrBuilder getExtraParamsOrBuilder(int index)
```
    repeated .milvus.grpc.KeyValuePair extra_params = 5;
    
    Specified by:
    
    getExtraParamsOrBuilder in interface SearchParamOrBuilder
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3
  - writeTo
```
public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException
```
    Specified by:
    
    writeTo in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    writeTo in class com.google.protobuf.GeneratedMessageV3
    
    Throws:
    
    IOException
  - getSerializedSize
```
public int getSerializedSize()
```
    Specified by:
    
    getSerializedSize in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getSerializedSize in class com.google.protobuf.GeneratedMessageV3
  - equals
```
public boolean equals(Object obj)
```
    Specified by:
    
    equals in interface com.google.protobuf.Message
    
    Overrides:
    
    equals in class com.google.protobuf.AbstractMessage
  - hashCode
```
public int hashCode()
```
    Specified by:
    
    hashCode in interface com.google.protobuf.Message
    
    Overrides:
    
    hashCode in class com.google.protobuf.AbstractMessage
  - parseFrom
```
public static SearchParam parseFrom(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SearchParam parseFrom(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SearchParam parseFrom(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SearchParam parseFrom(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SearchParam parseFrom(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SearchParam parseFrom(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
```
    Throws:
    
    com.google.protobuf.InvalidProtocolBufferException
  - parseFrom
```
public static SearchParam parseFrom(InputStream input)
                             throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static SearchParam parseFrom(InputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static SearchParam parseDelimitedFrom(InputStream input)
                                      throws IOException
```
    Throws:
    
    IOException
  - parseDelimitedFrom
```
public static SearchParam parseDelimitedFrom(InputStream input,
                                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                      throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static SearchParam parseFrom(com.google.protobuf.CodedInputStream input)
                             throws IOException
```
    Throws:
    
    IOException
  - parseFrom
```
public static SearchParam parseFrom(com.google.protobuf.CodedInputStream input,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws IOException
```
    Throws:
    
    IOException
  - newBuilderForType
```
public SearchParam.Builder newBuilderForType()
```
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.Message
    
    Specified by:
    
    newBuilderForType in interface com.google.protobuf.MessageLite
  - newBuilder
```
public static SearchParam.Builder newBuilder()
```
  - newBuilder
```
public static SearchParam.Builder newBuilder(SearchParam prototype)
```
  - toBuilder
```
public SearchParam.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface com.google.protobuf.Message
    
    Specified by:
    
    toBuilder in interface com.google.protobuf.MessageLite
  - newBuilderForType
```
protected SearchParam.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
```
    Specified by:
    
    newBuilderForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstance
```
public static SearchParam getDefaultInstance()
```
  - parser
```
public static com.google.protobuf.Parser<SearchParam> parser()
```
  - getParserForType
```
public com.google.protobuf.Parser<SearchParam> getParserForType()
```
    Specified by:
    
    getParserForType in interface com.google.protobuf.Message
    
    Specified by:
    
    getParserForType in interface com.google.protobuf.MessageLite
    
    Overrides:
    
    getParserForType in class com.google.protobuf.GeneratedMessageV3
  - getDefaultInstanceForType
```
public SearchParam getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

Class SearchParam

Nested Class Summary

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

Field Summary

Fields inherited from class com.google.protobuf.GeneratedMessageV3

Fields inherited from class com.google.protobuf.AbstractMessage

Fields inherited from class com.google.protobuf.AbstractMessageLite

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3

Methods inherited from class com.google.protobuf.AbstractMessage

Methods inherited from class com.google.protobuf.AbstractMessageLite

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageLite

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Field Detail

COLLECTION_NAME_FIELD_NUMBER

PARTITION_TAG_ARRAY_FIELD_NUMBER

QUERY_RECORD_ARRAY_FIELD_NUMBER

TOPK_FIELD_NUMBER

EXTRA_PARAMS_FIELD_NUMBER

Method Detail

newInstance

getUnknownFields

getDescriptor

internalGetFieldAccessorTable

getCollectionName

getCollectionNameBytes

getPartitionTagArrayList

getPartitionTagArrayCount

getPartitionTagArray

getPartitionTagArrayBytes

getQueryRecordArrayList

getQueryRecordArrayOrBuilderList

getQueryRecordArrayCount

getQueryRecordArray

getQueryRecordArrayOrBuilder

getTopk

getExtraParamsList

getExtraParamsOrBuilderList

getExtraParamsCount

getExtraParams

getExtraParamsOrBuilder

isInitialized

writeTo

getSerializedSize

equals

hashCode

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseFrom

parseDelimitedFrom

parseDelimitedFrom

parseFrom

parseFrom

newBuilderForType

newBuilder

newBuilder

toBuilder

newBuilderForType

getDefaultInstance

parser

getParserForType

getDefaultInstanceForType