Package io.dingodb.common

Class Common.DocumentSearchParameter

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

  • Field Details

    • TOP_N_FIELD_NUMBER

      public static final int TOP_N_FIELD_NUMBER
      See Also:

    • QUERY_STRING_FIELD_NUMBER

      public static final int QUERY_STRING_FIELD_NUMBER
      See Also:

    • USE_ID_FILTER_FIELD_NUMBER

      public static final int USE_ID_FILTER_FIELD_NUMBER
      See Also:

    • DOCUMENT_IDS_FIELD_NUMBER

      public static final int DOCUMENT_IDS_FIELD_NUMBER
      See Also:

    • COLUMN_NAMES_FIELD_NUMBER

      public static final int COLUMN_NAMES_FIELD_NUMBER
      See Also:

    • WITHOUT_SCALAR_DATA_FIELD_NUMBER

      public static final int WITHOUT_SCALAR_DATA_FIELD_NUMBER
      See Also:

    • SELECTED_KEYS_FIELD_NUMBER

      public static final int SELECTED_KEYS_FIELD_NUMBER
      See Also:

    • WITHOUT_TABLE_DATA_FIELD_NUMBER

      public static final int WITHOUT_TABLE_DATA_FIELD_NUMBER
      See Also:

    • QUERY_UNLIMITED_FIELD_NUMBER

      public static final int QUERY_UNLIMITED_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()

    • internalGetFieldAccessorTable

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

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

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

    • getUseIdFilter

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

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

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

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

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

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

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Common.DocumentSearchParameter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Common.DocumentSearchParameter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Common.DocumentSearchParameter.Builder newBuilder()

    • newBuilder

      public static Common.DocumentSearchParameter.Builder newBuilder(Common.DocumentSearchParameter prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Common.DocumentSearchParameter getDefaultInstance()

    • parser

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

    • getParserForType

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