Package io.milvus.grpc

Class SearchRequest.Builder

  • All Implemented Interfaces:
    com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, SearchRequestOrBuilder, Cloneable
    Enclosing class:
    SearchRequest
    public static final class SearchRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>
implements SearchRequestOrBuilder
    Protobuf type milvus.proto.milvus.SearchRequest

    • Method Detail

      • 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.Builder<SearchRequest.Builder>

      • clear

        public SearchRequest.Builder clear()
        Specified by:
        clear in interface com.google.protobuf.Message.Builder
        Specified by:
        clear in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clear in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.Message.Builder
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • getDefaultInstanceForType

        public SearchRequest getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

      • build

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

      • buildPartial

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

      • clone

        public SearchRequest.Builder clone()
        Specified by:
        clone in interface com.google.protobuf.Message.Builder
        Specified by:
        clone in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        clone in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • setField

        public SearchRequest.Builder setField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                      Object value)
        Specified by:
        setField in interface com.google.protobuf.Message.Builder
        Overrides:
        setField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • clearField

        public SearchRequest.Builder clearField​(com.google.protobuf.Descriptors.FieldDescriptor field)
        Specified by:
        clearField in interface com.google.protobuf.Message.Builder
        Overrides:
        clearField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • clearOneof

        public SearchRequest.Builder clearOneof​(com.google.protobuf.Descriptors.OneofDescriptor oneof)
        Specified by:
        clearOneof in interface com.google.protobuf.Message.Builder
        Overrides:
        clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • setRepeatedField

        public SearchRequest.Builder setRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              int index,
                                              Object value)
        Specified by:
        setRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • addRepeatedField

        public SearchRequest.Builder addRepeatedField​(com.google.protobuf.Descriptors.FieldDescriptor field,
                                              Object value)
        Specified by:
        addRepeatedField in interface com.google.protobuf.Message.Builder
        Overrides:
        addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • mergeFrom

        public SearchRequest.Builder mergeFrom​(com.google.protobuf.Message other)
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • mergeFrom

        public SearchRequest.Builder mergeFrom​(com.google.protobuf.CodedInputStream input,
                                       com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                throws IOException
        Specified by:
        mergeFrom in interface com.google.protobuf.Message.Builder
        Specified by:
        mergeFrom in interface com.google.protobuf.MessageLite.Builder
        Overrides:
        mergeFrom in class com.google.protobuf.AbstractMessage.Builder<SearchRequest.Builder>
        Throws:
        IOException

      • hasBase

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

      • getBaseBuilder

        public MsgBase.Builder getBaseBuilder()
         must
        .milvus.proto.common.MsgBase base = 1;

      • getDbNameBytes

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

      • setDbName

        public SearchRequest.Builder setDbName​(String value)
        string db_name = 2;
        Parameters:
        value - The dbName to set.
        Returns:
        This builder for chaining.

      • clearDbName

        public SearchRequest.Builder clearDbName()
        string db_name = 2;
        Returns:
        This builder for chaining.

      • setDbNameBytes

        public SearchRequest.Builder setDbNameBytes​(com.google.protobuf.ByteString value)
        string db_name = 2;
        Parameters:
        value - The bytes for dbName to set.
        Returns:
        This builder for chaining.

      • getCollectionNameBytes

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

      • setCollectionName

        public SearchRequest.Builder setCollectionName​(String value)
         must
        string collection_name = 3;
        Parameters:
        value - The collectionName to set.
        Returns:
        This builder for chaining.

      • clearCollectionName

        public SearchRequest.Builder clearCollectionName()
         must
        string collection_name = 3;
        Returns:
        This builder for chaining.

      • setCollectionNameBytes

        public SearchRequest.Builder setCollectionNameBytes​(com.google.protobuf.ByteString value)
         must
        string collection_name = 3;
        Parameters:
        value - The bytes for collectionName to set.
        Returns:
        This builder for chaining.

      • 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.

      • setPartitionNames

        public SearchRequest.Builder setPartitionNames​(int index,
                                               String value)
         must
        repeated string partition_names = 4;
        Parameters:
        index - The index to set the value at.
        value - The partitionNames to set.
        Returns:
        This builder for chaining.

      • addPartitionNames

        public SearchRequest.Builder addPartitionNames​(String value)
         must
        repeated string partition_names = 4;
        Parameters:
        value - The partitionNames to add.
        Returns:
        This builder for chaining.

      • addAllPartitionNames

        public SearchRequest.Builder addAllPartitionNames​(Iterable<String> values)
         must
        repeated string partition_names = 4;
        Parameters:
        values - The partitionNames to add.
        Returns:
        This builder for chaining.

      • clearPartitionNames

        public SearchRequest.Builder clearPartitionNames()
         must
        repeated string partition_names = 4;
        Returns:
        This builder for chaining.

      • addPartitionNamesBytes

        public SearchRequest.Builder addPartitionNamesBytes​(com.google.protobuf.ByteString value)
         must
        repeated string partition_names = 4;
        Parameters:
        value - The bytes of the partitionNames to add.
        Returns:
        This builder for chaining.

      • getDslBytes

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

      • setDsl

        public SearchRequest.Builder setDsl​(String value)
         must
        string dsl = 5;
        Parameters:
        value - The dsl to set.
        Returns:
        This builder for chaining.

      • clearDsl

        public SearchRequest.Builder clearDsl()
         must
        string dsl = 5;
        Returns:
        This builder for chaining.

      • setDslBytes

        public SearchRequest.Builder setDslBytes​(com.google.protobuf.ByteString value)
         must
        string dsl = 5;
        Parameters:
        value - The bytes for dsl to set.
        Returns:
        This builder for chaining.

      • getPlaceholderGroup

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

      • setPlaceholderGroup

        public SearchRequest.Builder setPlaceholderGroup​(com.google.protobuf.ByteString value)
         serialized `PlaceholderGroup`
        bytes placeholder_group = 6;
        Parameters:
        value - The placeholderGroup to set.
        Returns:
        This builder for chaining.

      • clearPlaceholderGroup

        public SearchRequest.Builder clearPlaceholderGroup()
         serialized `PlaceholderGroup`
        bytes placeholder_group = 6;
        Returns:
        This builder for chaining.

      • 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.

      • setDslTypeValue

        public SearchRequest.Builder setDslTypeValue​(int value)
         must
        .milvus.proto.common.DslType dsl_type = 7;
        Parameters:
        value - The enum numeric value on the wire for dslType to set.
        Returns:
        This builder for chaining.

      • setDslType

        public SearchRequest.Builder setDslType​(DslType value)
         must
        .milvus.proto.common.DslType dsl_type = 7;
        Parameters:
        value - The dslType to set.
        Returns:
        This builder for chaining.

      • clearDslType

        public SearchRequest.Builder clearDslType()
         must
        .milvus.proto.common.DslType dsl_type = 7;
        Returns:
        This builder for chaining.

      • 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.

      • setOutputFields

        public SearchRequest.Builder setOutputFields​(int index,
                                             String value)
        repeated string output_fields = 8;
        Parameters:
        index - The index to set the value at.
        value - The outputFields to set.
        Returns:
        This builder for chaining.

      • addOutputFields

        public SearchRequest.Builder addOutputFields​(String value)
        repeated string output_fields = 8;
        Parameters:
        value - The outputFields to add.
        Returns:
        This builder for chaining.

      • addAllOutputFields

        public SearchRequest.Builder addAllOutputFields​(Iterable<String> values)
        repeated string output_fields = 8;
        Parameters:
        values - The outputFields to add.
        Returns:
        This builder for chaining.

      • clearOutputFields

        public SearchRequest.Builder clearOutputFields()
        repeated string output_fields = 8;
        Returns:
        This builder for chaining.

      • addOutputFieldsBytes

        public SearchRequest.Builder addOutputFieldsBytes​(com.google.protobuf.ByteString value)
        repeated string output_fields = 8;
        Parameters:
        value - The bytes of the outputFields to add.
        Returns:
        This builder for chaining.

      • setSearchParams

        public SearchRequest.Builder setSearchParams​(int index,
                                             KeyValuePair value)
         must
        repeated .milvus.proto.common.KeyValuePair search_params = 9;

      • addSearchParams

        public SearchRequest.Builder addSearchParams​(int index,
                                             KeyValuePair value)
         must
        repeated .milvus.proto.common.KeyValuePair search_params = 9;

      • clearSearchParams

        public SearchRequest.Builder clearSearchParams()
         must
        repeated .milvus.proto.common.KeyValuePair search_params = 9;

      • removeSearchParams

        public SearchRequest.Builder removeSearchParams​(int index)
         must
        repeated .milvus.proto.common.KeyValuePair search_params = 9;

      • getSearchParamsBuilder

        public KeyValuePair.Builder getSearchParamsBuilder​(int index)
         must
        repeated .milvus.proto.common.KeyValuePair search_params = 9;

      • addSearchParamsBuilder

        public KeyValuePair.Builder addSearchParamsBuilder()
         must
        repeated .milvus.proto.common.KeyValuePair search_params = 9;

      • addSearchParamsBuilder

        public KeyValuePair.Builder addSearchParamsBuilder​(int index)
         must
        repeated .milvus.proto.common.KeyValuePair search_params = 9;

      • getSearchParamsBuilderList

        public List<KeyValuePair.Builder> getSearchParamsBuilderList()
         must
        repeated .milvus.proto.common.KeyValuePair search_params = 9;

      • setTravelTimestamp

        public SearchRequest.Builder setTravelTimestamp​(long value)
        uint64 travel_timestamp = 10;
        Parameters:
        value - The travelTimestamp to set.
        Returns:
        This builder for chaining.

      • clearTravelTimestamp

        public SearchRequest.Builder clearTravelTimestamp()
        uint64 travel_timestamp = 10;
        Returns:
        This builder for chaining.

      • getGuaranteeTimestamp

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

      • setGuaranteeTimestamp

        public SearchRequest.Builder setGuaranteeTimestamp​(long value)
         guarantee_timestamp
        uint64 guarantee_timestamp = 11;
        Parameters:
        value - The guaranteeTimestamp to set.
        Returns:
        This builder for chaining.

      • clearGuaranteeTimestamp

        public SearchRequest.Builder clearGuaranteeTimestamp()
         guarantee_timestamp
        uint64 guarantee_timestamp = 11;
        Returns:
        This builder for chaining.

      • setNq

        public SearchRequest.Builder setNq​(long value)
        int64 nq = 12;
        Parameters:
        value - The nq to set.
        Returns:
        This builder for chaining.

      • setNotReturnAllMeta

        public SearchRequest.Builder setNotReturnAllMeta​(boolean value)
        bool not_return_all_meta = 13;
        Parameters:
        value - The notReturnAllMeta to set.
        Returns:
        This builder for chaining.

      • clearNotReturnAllMeta

        public SearchRequest.Builder clearNotReturnAllMeta()
        bool not_return_all_meta = 13;
        Returns:
        This builder for chaining.

      • 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.

      • setConsistencyLevelValue

        public SearchRequest.Builder setConsistencyLevelValue​(int value)
        .milvus.proto.common.ConsistencyLevel consistency_level = 14;
        Parameters:
        value - The enum numeric value on the wire for consistencyLevel to set.
        Returns:
        This builder for chaining.

      • setConsistencyLevel

        public SearchRequest.Builder setConsistencyLevel​(ConsistencyLevel value)
        .milvus.proto.common.ConsistencyLevel consistency_level = 14;
        Parameters:
        value - The consistencyLevel to set.
        Returns:
        This builder for chaining.

      • clearConsistencyLevel

        public SearchRequest.Builder clearConsistencyLevel()
        .milvus.proto.common.ConsistencyLevel consistency_level = 14;
        Returns:
        This builder for chaining.

      • setUseDefaultConsistency

        public SearchRequest.Builder setUseDefaultConsistency​(boolean value)
        bool use_default_consistency = 15;
        Parameters:
        value - The useDefaultConsistency to set.
        Returns:
        This builder for chaining.

      • clearUseDefaultConsistency

        public SearchRequest.Builder clearUseDefaultConsistency()
        bool use_default_consistency = 15;
        Returns:
        This builder for chaining.

      • setSearchByPrimaryKeys

        public SearchRequest.Builder setSearchByPrimaryKeys​(boolean value)
        bool search_by_primary_keys = 16;
        Parameters:
        value - The searchByPrimaryKeys to set.
        Returns:
        This builder for chaining.

      • clearSearchByPrimaryKeys

        public SearchRequest.Builder clearSearchByPrimaryKeys()
        bool search_by_primary_keys = 16;
        Returns:
        This builder for chaining.

      • clearSubReqs

        public SearchRequest.Builder clearSubReqs()
        repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;

      • removeSubReqs

        public SearchRequest.Builder removeSubReqs​(int index)
        repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;

      • getSubReqsBuilder

        public SubSearchRequest.Builder getSubReqsBuilder​(int index)
        repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;

      • addSubReqsBuilder

        public SubSearchRequest.Builder addSubReqsBuilder()
        repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;

      • addSubReqsBuilder

        public SubSearchRequest.Builder addSubReqsBuilder​(int index)
        repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;

      • getSubReqsBuilderList

        public List<SubSearchRequest.Builder> getSubReqsBuilderList()
        repeated .milvus.proto.milvus.SubSearchRequest sub_reqs = 17;

      • setUnknownFields

        public final SearchRequest.Builder setUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        setUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>

      • mergeUnknownFields

        public final SearchRequest.Builder mergeUnknownFields​(com.google.protobuf.UnknownFieldSet unknownFields)
        Specified by:
        mergeUnknownFields in interface com.google.protobuf.Message.Builder
        Overrides:
        mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<SearchRequest.Builder>