Package io.dingodb.common

Class Common.DocumentSearchParameter.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<Common.DocumentSearchParameter.Builder>
io.dingodb.common.Common.DocumentSearchParameter.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Common.DocumentSearchParameterOrBuilder, Cloneable
Enclosing class:
Common.DocumentSearchParameter
public static final class Common.DocumentSearchParameter.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<Common.DocumentSearchParameter.Builder> implements Common.DocumentSearchParameterOrBuilder
Protobuf type dingodb.pb.common.DocumentSearchParameter

  • Method Details

    • 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<Common.DocumentSearchParameter.Builder>

    • clear

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • setField

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • clearField

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • clearOneof

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • setRepeatedField

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • addRepeatedField

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • mergeFrom

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • mergeFrom

      public Common.DocumentSearchParameter.Builder mergeFrom(Common.DocumentSearchParameter other)

    • isInitialized

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

    • mergeFrom

      public Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>
      Throws:
      IOException

    • getTopN

      public int getTopN()
       The number of top results to return.
      uint32 top_n = 1;
      Specified by:
      getTopN in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The topN.

    • setTopN

      public Common.DocumentSearchParameter.Builder setTopN(int value)
       The number of top results to return.
      uint32 top_n = 1;
      Parameters:
      value - The topN to set.
      Returns:
      This builder for chaining.

    • clearTopN

      public Common.DocumentSearchParameter.Builder clearTopN()
       The number of top results to return.
      uint32 top_n = 1;
      Returns:
      This builder for chaining.

    • getQueryString

      public String getQueryString()
       The query_string for search
      string query_string = 2;
      Specified by:
      getQueryString in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The queryString.

    • getQueryStringBytes

      public com.google.protobuf.ByteString getQueryStringBytes()
       The query_string for search
      string query_string = 2;
      Specified by:
      getQueryStringBytes in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The bytes for queryString.

    • setQueryString

      public Common.DocumentSearchParameter.Builder setQueryString(String value)
       The query_string for search
      string query_string = 2;
      Parameters:
      value - The queryString to set.
      Returns:
      This builder for chaining.

    • clearQueryString

      public Common.DocumentSearchParameter.Builder clearQueryString()
       The query_string for search
      string query_string = 2;
      Returns:
      This builder for chaining.

    • setQueryStringBytes

      public Common.DocumentSearchParameter.Builder setQueryStringBytes(com.google.protobuf.ByteString value)
       The query_string for search
      string query_string = 2;
      Parameters:
      value - The bytes for queryString to set.
      Returns:
      This builder for chaining.

    • getUseIdFilter

      public boolean getUseIdFilter()
       use id filter
      bool use_id_filter = 3;
      Specified by:
      getUseIdFilter in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The useIdFilter.

    • setUseIdFilter

      public Common.DocumentSearchParameter.Builder setUseIdFilter(boolean value)
       use id filter
      bool use_id_filter = 3;
      Parameters:
      value - The useIdFilter to set.
      Returns:
      This builder for chaining.

    • clearUseIdFilter

      public Common.DocumentSearchParameter.Builder clearUseIdFilter()
       use id filter
      bool use_id_filter = 3;
      Returns:
      This builder for chaining.

    • getDocumentIdsList

      public List<Long> getDocumentIdsList()
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Specified by:
      getDocumentIdsList in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      A list containing the documentIds.

    • getDocumentIdsCount

      public int getDocumentIdsCount()
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Specified by:
      getDocumentIdsCount in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The count of documentIds.

    • getDocumentIds

      public long getDocumentIds(int index)
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Specified by:
      getDocumentIds in interface Common.DocumentSearchParameterOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The documentIds at the given index.

    • setDocumentIds

      public Common.DocumentSearchParameter.Builder setDocumentIds(int index, long value)
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Parameters:
      index - The index to set the value at.
      value - The documentIds to set.
      Returns:
      This builder for chaining.

    • addDocumentIds

      public Common.DocumentSearchParameter.Builder addDocumentIds(long value)
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Parameters:
      value - The documentIds to add.
      Returns:
      This builder for chaining.

    • addAllDocumentIds

      public Common.DocumentSearchParameter.Builder addAllDocumentIds(Iterable<? extends Long> values)
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Parameters:
      values - The documentIds to add.
      Returns:
      This builder for chaining.

    • clearDocumentIds

      public Common.DocumentSearchParameter.Builder clearDocumentIds()
       if use_id_filter = true, use this field
      repeated int64 document_ids = 4;
      Returns:
      This builder for chaining.

    • getColumnNamesList

      public com.google.protobuf.ProtocolStringList getColumnNamesList()
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Specified by:
      getColumnNamesList in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      A list containing the columnNames.

    • getColumnNamesCount

      public int getColumnNamesCount()
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Specified by:
      getColumnNamesCount in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The count of columnNames.

    • getColumnNames

      public String getColumnNames(int index)
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Specified by:
      getColumnNames in interface Common.DocumentSearchParameterOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The columnNames at the given index.

    • getColumnNamesBytes

      public com.google.protobuf.ByteString getColumnNamesBytes(int index)
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Specified by:
      getColumnNamesBytes in interface Common.DocumentSearchParameterOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the columnNames at the given index.

    • setColumnNames

      public Common.DocumentSearchParameter.Builder setColumnNames(int index, String value)
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Parameters:
      index - The index to set the value at.
      value - The columnNames to set.
      Returns:
      This builder for chaining.

    • addColumnNames

      public Common.DocumentSearchParameter.Builder addColumnNames(String value)
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Parameters:
      value - The columnNames to add.
      Returns:
      This builder for chaining.

    • addAllColumnNames

      public Common.DocumentSearchParameter.Builder addAllColumnNames(Iterable<String> values)
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Parameters:
      values - The columnNames to add.
      Returns:
      This builder for chaining.

    • clearColumnNames

      public Common.DocumentSearchParameter.Builder clearColumnNames()
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Returns:
      This builder for chaining.

    • addColumnNamesBytes

      public Common.DocumentSearchParameter.Builder addColumnNamesBytes(com.google.protobuf.ByteString value)
       use column filter
 if query_string is simple string, use column_names to select columns
 if query_string is full functional expr, like "col1: value1 AND col2: value2", column_names is ignored
      repeated string column_names = 5;
      Parameters:
      value - The bytes of the columnNames to add.
      Returns:
      This builder for chaining.

    • getWithoutScalarData

      public boolean getWithoutScalarData()
       for output, if only id is needed, set without_scalar_data = true
 else set without_scalar_data = false, and set selected_keys to select scalar data
      bool without_scalar_data = 10;
      Specified by:
      getWithoutScalarData in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The withoutScalarData.

    • setWithoutScalarData

      public Common.DocumentSearchParameter.Builder setWithoutScalarData(boolean value)
       for output, if only id is needed, set without_scalar_data = true
 else set without_scalar_data = false, and set selected_keys to select scalar data
      bool without_scalar_data = 10;
      Parameters:
      value - The withoutScalarData to set.
      Returns:
      This builder for chaining.

    • clearWithoutScalarData

      public Common.DocumentSearchParameter.Builder clearWithoutScalarData()
       for output, if only id is needed, set without_scalar_data = true
 else set without_scalar_data = false, and set selected_keys to select scalar data
      bool without_scalar_data = 10;
      Returns:
      This builder for chaining.

    • getSelectedKeysList

      public com.google.protobuf.ProtocolStringList getSelectedKeysList()
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Specified by:
      getSelectedKeysList in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      A list containing the selectedKeys.

    • getSelectedKeysCount

      public int getSelectedKeysCount()
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Specified by:
      getSelectedKeysCount in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The count of selectedKeys.

    • getSelectedKeys

      public String getSelectedKeys(int index)
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Specified by:
      getSelectedKeys in interface Common.DocumentSearchParameterOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The selectedKeys at the given index.

    • getSelectedKeysBytes

      public com.google.protobuf.ByteString getSelectedKeysBytes(int index)
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Specified by:
      getSelectedKeysBytes in interface Common.DocumentSearchParameterOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedKeys at the given index.

    • setSelectedKeys

      public Common.DocumentSearchParameter.Builder setSelectedKeys(int index, String value)
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Parameters:
      index - The index to set the value at.
      value - The selectedKeys to set.
      Returns:
      This builder for chaining.

    • addSelectedKeys

      public Common.DocumentSearchParameter.Builder addSelectedKeys(String value)
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Parameters:
      value - The selectedKeys to add.
      Returns:
      This builder for chaining.

    • addAllSelectedKeys

      public Common.DocumentSearchParameter.Builder addAllSelectedKeys(Iterable<String> values)
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Parameters:
      values - The selectedKeys to add.
      Returns:
      This builder for chaining.

    • clearSelectedKeys

      public Common.DocumentSearchParameter.Builder clearSelectedKeys()
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Returns:
      This builder for chaining.

    • addSelectedKeysBytes

      public Common.DocumentSearchParameter.Builder addSelectedKeysBytes(com.google.protobuf.ByteString value)
       If without_scalar_data is false, selected_keys is used to select scalar data,
      repeated string selected_keys = 11;
      Parameters:
      value - The bytes of the selectedKeys to add.
      Returns:
      This builder for chaining.

    • getWithoutTableData

      public boolean getWithoutTableData()
       if this parameter is null, all scalar data will be returned.
      bool without_table_data = 12;
      Specified by:
      getWithoutTableData in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The withoutTableData.

    • setWithoutTableData

      public Common.DocumentSearchParameter.Builder setWithoutTableData(boolean value)
       if this parameter is null, all scalar data will be returned.
      bool without_table_data = 12;
      Parameters:
      value - The withoutTableData to set.
      Returns:
      This builder for chaining.

    • clearWithoutTableData

      public Common.DocumentSearchParameter.Builder clearWithoutTableData()
       if this parameter is null, all scalar data will be returned.
      bool without_table_data = 12;
      Returns:
      This builder for chaining.

    • getQueryUnlimited

      public boolean getQueryUnlimited()
       if query_unlimited = true, top_n is igonred
      bool query_unlimited = 13;
      Specified by:
      getQueryUnlimited in interface Common.DocumentSearchParameterOrBuilder
      Returns:
      The queryUnlimited.

    • setQueryUnlimited

      public Common.DocumentSearchParameter.Builder setQueryUnlimited(boolean value)
       if query_unlimited = true, top_n is igonred
      bool query_unlimited = 13;
      Parameters:
      value - The queryUnlimited to set.
      Returns:
      This builder for chaining.

    • clearQueryUnlimited

      public Common.DocumentSearchParameter.Builder clearQueryUnlimited()
       if query_unlimited = true, top_n is igonred
      bool query_unlimited = 13;
      Returns:
      This builder for chaining.

    • setUnknownFields

      public final Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>

    • mergeUnknownFields

      public final Common.DocumentSearchParameter.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<Common.DocumentSearchParameter.Builder>