Class 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:
    Serialized Form
    • Field Detail

      • COLLECTION_NAME_FIELD_NUMBER

        public static final int COLLECTION_NAME_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PARTITION_NAMES_FIELD_NUMBER

        public static final int PARTITION_NAMES_FIELD_NUMBER
        See Also:
        Constant Field Values
      • PLACEHOLDER_GROUP_FIELD_NUMBER

        public static final int PLACEHOLDER_GROUP_FIELD_NUMBER
        See Also:
        Constant Field Values
      • OUTPUT_FIELDS_FIELD_NUMBER

        public static final int OUTPUT_FIELDS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SEARCH_PARAMS_FIELD_NUMBER

        public static final int SEARCH_PARAMS_FIELD_NUMBER
        See Also:
        Constant Field Values
      • TRAVEL_TIMESTAMP_FIELD_NUMBER

        public static final int TRAVEL_TIMESTAMP_FIELD_NUMBER
        See Also:
        Constant Field Values
      • GUARANTEE_TIMESTAMP_FIELD_NUMBER

        public static final int GUARANTEE_TIMESTAMP_FIELD_NUMBER
        See Also:
        Constant Field Values
      • NOT_RETURN_ALL_META_FIELD_NUMBER

        public static final int NOT_RETURN_ALL_META_FIELD_NUMBER
        See Also:
        Constant Field Values
      • CONSISTENCY_LEVEL_FIELD_NUMBER

        public static final int CONSISTENCY_LEVEL_FIELD_NUMBER
        See Also:
        Constant Field Values
      • USE_DEFAULT_CONSISTENCY_FIELD_NUMBER

        public static final int USE_DEFAULT_CONSISTENCY_FIELD_NUMBER
        See Also:
        Constant Field Values
      • SEARCH_BY_PRIMARY_KEYS_FIELD_NUMBER

        public static final int SEARCH_BY_PRIMARY_KEYS_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
      • 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
      • hasBase

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

        public com.google.protobuf.ByteString getDbNameBytes()
        string db_name = 2;
        Specified by:
        getDbNameBytes in interface SearchRequestOrBuilder
        Returns:
        The bytes for dbName.
      • 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.
      • 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.
      • 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.
      • getOutputFieldsList

        public com.google.protobuf.ProtocolStringList getOutputFieldsList()
        repeated string output_fields = 8;
        Specified by:
        getOutputFieldsList in interface SearchRequestOrBuilder
        Returns:
        A list containing the 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.
      • getGuaranteeTimestamp

        public long getGuaranteeTimestamp()
         guarantee_timestamp
         
        uint64 guarantee_timestamp = 11;
        Specified by:
        getGuaranteeTimestamp in interface SearchRequestOrBuilder
        Returns:
        The guaranteeTimestamp.
      • 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.
      • 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​(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
      • 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