Package io.milvus.grpc

Class SearchRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.milvus.grpc.SearchRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SearchRequestOrBuilder, Serializable
public final class SearchRequest extends com.google.protobuf.GeneratedMessageV3 implements SearchRequestOrBuilder
Protobuf type milvus.proto.milvus.SearchRequest
See Also:

  • Field Details

    • BASE_FIELD_NUMBER

      public static final int BASE_FIELD_NUMBER
      See Also:

    • DB_NAME_FIELD_NUMBER

      public static final int DB_NAME_FIELD_NUMBER
      See Also:

    • COLLECTION_NAME_FIELD_NUMBER

      public static final int COLLECTION_NAME_FIELD_NUMBER
      See Also:

    • PARTITION_NAMES_FIELD_NUMBER

      public static final int PARTITION_NAMES_FIELD_NUMBER
      See Also:

    • DSL_FIELD_NUMBER

      public static final int DSL_FIELD_NUMBER
      See Also:

    • PLACEHOLDER_GROUP_FIELD_NUMBER

      public static final int PLACEHOLDER_GROUP_FIELD_NUMBER
      See Also:

    • DSL_TYPE_FIELD_NUMBER

      public static final int DSL_TYPE_FIELD_NUMBER
      See Also:

    • OUTPUT_FIELDS_FIELD_NUMBER

      public static final int OUTPUT_FIELDS_FIELD_NUMBER
      See Also:

    • SEARCH_PARAMS_FIELD_NUMBER

      public static final int SEARCH_PARAMS_FIELD_NUMBER
      See Also:

    • TRAVEL_TIMESTAMP_FIELD_NUMBER

      public static final int TRAVEL_TIMESTAMP_FIELD_NUMBER
      See Also:

    • GUARANTEE_TIMESTAMP_FIELD_NUMBER

      public static final int GUARANTEE_TIMESTAMP_FIELD_NUMBER
      See Also:

    • NQ_FIELD_NUMBER

      public static final int NQ_FIELD_NUMBER
      See Also:

    • NOT_RETURN_ALL_META_FIELD_NUMBER

      public static final int NOT_RETURN_ALL_META_FIELD_NUMBER
      See Also:

    • CONSISTENCY_LEVEL_FIELD_NUMBER

      public static final int CONSISTENCY_LEVEL_FIELD_NUMBER
      See Also:

    • USE_DEFAULT_CONSISTENCY_FIELD_NUMBER

      public static final int USE_DEFAULT_CONSISTENCY_FIELD_NUMBER
      See Also:

    • SEARCH_BY_PRIMARY_KEYS_FIELD_NUMBER

      public static final int SEARCH_BY_PRIMARY_KEYS_FIELD_NUMBER
      See Also:

    • SUB_REQS_FIELD_NUMBER

      public static final int SUB_REQS_FIELD_NUMBER
      See Also:

    • EXPR_TEMPLATE_VALUES_FIELD_NUMBER

      public static final int EXPR_TEMPLATE_VALUES_FIELD_NUMBER
      See Also:

    • FUNCTION_SCORE_FIELD_NUMBER

      public static final int FUNCTION_SCORE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasBase

      public boolean hasBase()
       must
      .milvus.proto.common.MsgBase base = 1;
      Specified by:
      hasBase in interface SearchRequestOrBuilder
      Returns:
      Whether the base field is set.

    • getBase

      public MsgBase getBase()
       must
      .milvus.proto.common.MsgBase base = 1;
      Specified by:
      getBase in interface SearchRequestOrBuilder
      Returns:
      The base.

    • getBaseOrBuilder

      public MsgBaseOrBuilder getBaseOrBuilder()
       must
      .milvus.proto.common.MsgBase base = 1;
      Specified by:
      getBaseOrBuilder in interface SearchRequestOrBuilder

    • getDbName

      public String getDbName()
      string db_name = 2;
      Specified by:
      getDbName in interface SearchRequestOrBuilder
      Returns:
      The dbName.

    • getDbNameBytes

      public com.google.protobuf.ByteString getDbNameBytes()
      string db_name = 2;
      Specified by:
      getDbNameBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for dbName.

    • getCollectionName

      public String getCollectionName()
       must
      string collection_name = 3;
      Specified by:
      getCollectionName in interface SearchRequestOrBuilder
      Returns:
      The collectionName.

    • getCollectionNameBytes

      public com.google.protobuf.ByteString getCollectionNameBytes()
       must
      string collection_name = 3;
      Specified by:
      getCollectionNameBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for collectionName.

    • getPartitionNamesList

      public com.google.protobuf.ProtocolStringList getPartitionNamesList()
       must
      repeated string partition_names = 4;
      Specified by:
      getPartitionNamesList in interface SearchRequestOrBuilder
      Returns:
      A list containing the partitionNames.

    • getPartitionNamesCount

      public int getPartitionNamesCount()
       must
      repeated string partition_names = 4;
      Specified by:
      getPartitionNamesCount in interface SearchRequestOrBuilder
      Returns:
      The count of partitionNames.

    • getPartitionNames

      public String getPartitionNames(int index)
       must
      repeated string partition_names = 4;
      Specified by:
      getPartitionNames in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The partitionNames at the given index.

    • getPartitionNamesBytes

      public com.google.protobuf.ByteString getPartitionNamesBytes(int index)
       must
      repeated string partition_names = 4;
      Specified by:
      getPartitionNamesBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the partitionNames at the given index.

    • getDsl

      public String getDsl()
       must
      string dsl = 5;
      Specified by:
      getDsl in interface SearchRequestOrBuilder
      Returns:
      The dsl.

    • getDslBytes

      public com.google.protobuf.ByteString getDslBytes()
       must
      string dsl = 5;
      Specified by:
      getDslBytes in interface SearchRequestOrBuilder
      Returns:
      The bytes for dsl.

    • getPlaceholderGroup

      public com.google.protobuf.ByteString getPlaceholderGroup()
       serialized `PlaceholderGroup`
      bytes placeholder_group = 6;
      Specified by:
      getPlaceholderGroup in interface SearchRequestOrBuilder
      Returns:
      The placeholderGroup.

    • getDslTypeValue

      public int getDslTypeValue()
       must
      .milvus.proto.common.DslType dsl_type = 7;
      Specified by:
      getDslTypeValue in interface SearchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for dslType.

    • getDslType

      public DslType getDslType()
       must
      .milvus.proto.common.DslType dsl_type = 7;
      Specified by:
      getDslType in interface SearchRequestOrBuilder
      Returns:
      The dslType.

    • getOutputFieldsList

      public com.google.protobuf.ProtocolStringList getOutputFieldsList()
      repeated string output_fields = 8;
      Specified by:
      getOutputFieldsList in interface SearchRequestOrBuilder
      Returns:
      A list containing the outputFields.

    • getOutputFieldsCount

      public int getOutputFieldsCount()
      repeated string output_fields = 8;
      Specified by:
      getOutputFieldsCount in interface SearchRequestOrBuilder
      Returns:
      The count of outputFields.

    • getOutputFields

      public String getOutputFields(int index)
      repeated string output_fields = 8;
      Specified by:
      getOutputFields in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The outputFields at the given index.

    • getOutputFieldsBytes

      public com.google.protobuf.ByteString getOutputFieldsBytes(int index)
      repeated string output_fields = 8;
      Specified by:
      getOutputFieldsBytes in interface SearchRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the outputFields at the given index.

    • getSearchParamsList

      public List<KeyValuePair> getSearchParamsList()
       must
      repeated .milvus.proto.common.KeyValuePair search_params = 9;
      Specified by:
      getSearchParamsList in interface SearchRequestOrBuilder

    • getSearchParamsOrBuilderList

      public List<? extends KeyValuePairOrBuilder> getSearchParamsOrBuilderList()
       must
      repeated .milvus.proto.common.KeyValuePair search_params = 9;
      Specified by:
      getSearchParamsOrBuilderList in interface SearchRequestOrBuilder

    • getSearchParamsCount

      public int getSearchParamsCount()
       must
      repeated .milvus.proto.common.KeyValuePair search_params = 9;
      Specified by:
      getSearchParamsCount in interface SearchRequestOrBuilder

    • getSearchParams

      public KeyValuePair getSearchParams(int index)
       must
      repeated .milvus.proto.common.KeyValuePair search_params = 9;
      Specified by:
      getSearchParams in interface SearchRequestOrBuilder

    • getSearchParamsOrBuilder

      public KeyValuePairOrBuilder getSearchParamsOrBuilder(int index)
       must
      repeated .milvus.proto.common.KeyValuePair search_params = 9;
      Specified by:
      getSearchParamsOrBuilder in interface SearchRequestOrBuilder

    • getTravelTimestamp

      public long getTravelTimestamp()
      uint64 travel_timestamp = 10;
      Specified by:
      getTravelTimestamp in interface SearchRequestOrBuilder
      Returns:
      The travelTimestamp.

    • getGuaranteeTimestamp

      public long getGuaranteeTimestamp()
       guarantee_timestamp
      uint64 guarantee_timestamp = 11;
      Specified by:
      getGuaranteeTimestamp in interface SearchRequestOrBuilder
      Returns:
      The guaranteeTimestamp.

    • getNq

      public long getNq()
      int64 nq = 12;
      Specified by:
      getNq in interface SearchRequestOrBuilder
      Returns:
      The nq.

    • getNotReturnAllMeta

      public boolean getNotReturnAllMeta()
      bool not_return_all_meta = 13;
      Specified by:
      getNotReturnAllMeta in interface SearchRequestOrBuilder
      Returns:
      The notReturnAllMeta.

    • getConsistencyLevelValue

      public int getConsistencyLevelValue()
      .milvus.proto.common.ConsistencyLevel consistency_level = 14;
      Specified by:
      getConsistencyLevelValue in interface SearchRequestOrBuilder
      Returns:
      The enum numeric value on the wire for consistencyLevel.

    • getConsistencyLevel

      public ConsistencyLevel getConsistencyLevel()
      .milvus.proto.common.ConsistencyLevel consistency_level = 14;
      Specified by:
      getConsistencyLevel in interface SearchRequestOrBuilder
      Returns:
      The consistencyLevel.

    • getUseDefaultConsistency

      public boolean getUseDefaultConsistency()
      bool use_default_consistency = 15;
      Specified by:
      getUseDefaultConsistency in interface SearchRequestOrBuilder
      Returns:
      The useDefaultConsistency.

    • getSearchByPrimaryKeys

      public boolean getSearchByPrimaryKeys()
      bool search_by_primary_keys = 16;
      Specified by:
      getSearchByPrimaryKeys in interface SearchRequestOrBuilder
      Returns:
      The searchByPrimaryKeys.

    • getSubReqsList

      public List<SubSearchRequest> getSubReqsList()
      repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;
      Specified by:
      getSubReqsList in interface SearchRequestOrBuilder

    • getSubReqsOrBuilderList

      public List<? extends SubSearchRequestOrBuilder> getSubReqsOrBuilderList()
      repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;
      Specified by:
      getSubReqsOrBuilderList in interface SearchRequestOrBuilder

    • getSubReqsCount

      public int getSubReqsCount()
      repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;
      Specified by:
      getSubReqsCount in interface SearchRequestOrBuilder

    • getSubReqs

      public SubSearchRequest getSubReqs(int index)
      repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;
      Specified by:
      getSubReqs in interface SearchRequestOrBuilder

    • getSubReqsOrBuilder

      public SubSearchRequestOrBuilder getSubReqsOrBuilder(int index)
      repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;
      Specified by:
      getSubReqsOrBuilder in interface SearchRequestOrBuilder

    • getExprTemplateValuesCount

      public int getExprTemplateValuesCount()
      Description copied from interface: SearchRequestOrBuilder
      map<string, .milvus.proto.schema.TemplateValue> expr_template_values = 18;
      Specified by:
      getExprTemplateValuesCount in interface SearchRequestOrBuilder

    • containsExprTemplateValues

      public boolean containsExprTemplateValues(String key)
      map<string, .milvus.proto.schema.TemplateValue> expr_template_values = 18;
      Specified by:
      containsExprTemplateValues in interface SearchRequestOrBuilder

    • getExprTemplateValues

      @Deprecated public Map<String,TemplateValue> getExprTemplateValues()
      Deprecated.
      Use getExprTemplateValuesMap() instead.
      Specified by:
      getExprTemplateValues in interface SearchRequestOrBuilder

    • getExprTemplateValuesMap

      public Map<String,TemplateValue> getExprTemplateValuesMap()
      map<string, .milvus.proto.schema.TemplateValue> expr_template_values = 18;
      Specified by:
      getExprTemplateValuesMap in interface SearchRequestOrBuilder

    • getExprTemplateValuesOrDefault

      public TemplateValue getExprTemplateValuesOrDefault(String key, TemplateValue defaultValue)
      map<string, .milvus.proto.schema.TemplateValue> expr_template_values = 18;
      Specified by:
      getExprTemplateValuesOrDefault in interface SearchRequestOrBuilder

    • getExprTemplateValuesOrThrow

      public TemplateValue getExprTemplateValuesOrThrow(String key)
      map<string, .milvus.proto.schema.TemplateValue> expr_template_values = 18;
      Specified by:
      getExprTemplateValuesOrThrow in interface SearchRequestOrBuilder

    • hasFunctionScore

      public boolean hasFunctionScore()
      .milvus.proto.schema.FunctionScore function_score = 19;
      Specified by:
      hasFunctionScore in interface SearchRequestOrBuilder
      Returns:
      Whether the functionScore field is set.

    • getFunctionScore

      public FunctionScore getFunctionScore()
      .milvus.proto.schema.FunctionScore function_score = 19;
      Specified by:
      getFunctionScore in interface SearchRequestOrBuilder
      Returns:
      The functionScore.

    • getFunctionScoreOrBuilder

      public FunctionScoreOrBuilder getFunctionScoreOrBuilder()
      .milvus.proto.schema.FunctionScore function_score = 19;
      Specified by:
      getFunctionScoreOrBuilder in interface SearchRequestOrBuilder

    • 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 SearchRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static SearchRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static SearchRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static SearchRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public SearchRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static SearchRequest.Builder newBuilder()

    • newBuilder

      public static SearchRequest.Builder newBuilder(SearchRequest prototype)

    • toBuilder

      public SearchRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected SearchRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static SearchRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<SearchRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<SearchRequest> 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 SearchRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder