Package io.dingodb.index

Class Index.VectorScanQueryRequest

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

  • Field Details

    • REQUEST_INFO_FIELD_NUMBER

      public static final int REQUEST_INFO_FIELD_NUMBER
      See Also:

    • CONTEXT_FIELD_NUMBER

      public static final int CONTEXT_FIELD_NUMBER
      See Also:

    • VECTOR_ID_START_FIELD_NUMBER

      public static final int VECTOR_ID_START_FIELD_NUMBER
      See Also:

    • IS_REVERSE_SCAN_FIELD_NUMBER

      public static final int IS_REVERSE_SCAN_FIELD_NUMBER
      See Also:

    • MAX_SCAN_COUNT_FIELD_NUMBER

      public static final int MAX_SCAN_COUNT_FIELD_NUMBER
      See Also:

    • VECTOR_ID_END_FIELD_NUMBER

      public static final int VECTOR_ID_END_FIELD_NUMBER
      See Also:

    • WITHOUT_VECTOR_DATA_FIELD_NUMBER

      public static final int WITHOUT_VECTOR_DATA_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:

    • USE_SCALAR_FILTER_FIELD_NUMBER

      public static final int USE_SCALAR_FILTER_FIELD_NUMBER
      See Also:

    • SCALAR_FOR_FILTER_FIELD_NUMBER

      public static final int SCALAR_FOR_FILTER_FIELD_NUMBER
      See Also:

    • TS_FIELD_NUMBER

      public static final int TS_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

    • hasRequestInfo

      public boolean hasRequestInfo()
      .dingodb.pb.common.RequestInfo request_info = 1;
      Specified by:
      hasRequestInfo in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      Whether the requestInfo field is set.

    • getRequestInfo

      public Common.RequestInfo getRequestInfo()
      .dingodb.pb.common.RequestInfo request_info = 1;
      Specified by:
      getRequestInfo in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The requestInfo.

    • getRequestInfoOrBuilder

      public Common.RequestInfoOrBuilder getRequestInfoOrBuilder()
      .dingodb.pb.common.RequestInfo request_info = 1;
      Specified by:
      getRequestInfoOrBuilder in interface Index.VectorScanQueryRequestOrBuilder

    • hasContext

      public boolean hasContext()
      .dingodb.pb.store.Context context = 2;
      Specified by:
      hasContext in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      Whether the context field is set.

    • getContext

      public Store.Context getContext()
      .dingodb.pb.store.Context context = 2;
      Specified by:
      getContext in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The context.

    • getContextOrBuilder

      public Store.ContextOrBuilder getContextOrBuilder()
      .dingodb.pb.store.Context context = 2;
      Specified by:
      getContextOrBuilder in interface Index.VectorScanQueryRequestOrBuilder

    • getVectorIdStart

      public long getVectorIdStart()
      int64 vector_id_start = 3;
      Specified by:
      getVectorIdStart in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The vectorIdStart.

    • getIsReverseScan

      public boolean getIsReverseScan()
      bool is_reverse_scan = 4;
      Specified by:
      getIsReverseScan in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The isReverseScan.

    • getMaxScanCount

      public long getMaxScanCount()
       the max count user want to scan
      int64 max_scan_count = 5;
      Specified by:
      getMaxScanCount in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The maxScanCount.

    • getVectorIdEnd

      public long getVectorIdEnd()
       the end id of scan, if is_reverse_scan is true, vector_id_end must be
 less than vector_id_start, if is_reverse_scan is false, vector_id_end
 must be greater than vector_id_start the real range is [start, end],
 include start and end if vector_id_end == 0, scan to the end of the
 region
      int64 vector_id_end = 6;
      Specified by:
      getVectorIdEnd in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The vectorIdEnd.

    • getWithoutVectorData

      public boolean getWithoutVectorData()
       Default false, if true, response without vector data.
      bool without_vector_data = 11;
      Specified by:
      getWithoutVectorData in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The withoutVectorData.

    • getWithoutScalarData

      public boolean getWithoutScalarData()
       Default false, if true, response without scalar data.
      bool without_scalar_data = 12;
      Specified by:
      getWithoutScalarData in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The withoutScalarData.

    • getSelectedKeysList

      public com.google.protobuf.ProtocolStringList getSelectedKeysList()
       If without_scalar_data is false, selected_keys is used to select scalar
 data, if this parameter is null, all scalar data will be returned.
      repeated string selected_keys = 13;
      Specified by:
      getSelectedKeysList in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      A list containing the selectedKeys.

    • getSelectedKeysCount

      public int getSelectedKeysCount()
       If without_scalar_data is false, selected_keys is used to select scalar
 data, if this parameter is null, all scalar data will be returned.
      repeated string selected_keys = 13;
      Specified by:
      getSelectedKeysCount in interface Index.VectorScanQueryRequestOrBuilder
      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, if this parameter is null, all scalar data will be returned.
      repeated string selected_keys = 13;
      Specified by:
      getSelectedKeys in interface Index.VectorScanQueryRequestOrBuilder
      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, if this parameter is null, all scalar data will be returned.
      repeated string selected_keys = 13;
      Specified by:
      getSelectedKeysBytes in interface Index.VectorScanQueryRequestOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedKeys at the given index.

    • getWithoutTableData

      public boolean getWithoutTableData()
       Default false, if true, response without table data.
      bool without_table_data = 14;
      Specified by:
      getWithoutTableData in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The withoutTableData.

    • getUseScalarFilter

      public boolean getUseScalarFilter()
       Whether to use scalar filtering.
      bool use_scalar_filter = 20;
      Specified by:
      getUseScalarFilter in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The useScalarFilter.

    • hasScalarForFilter

      public boolean hasScalarForFilter()
      .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;
      Specified by:
      hasScalarForFilter in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      Whether the scalarForFilter field is set.

    • getScalarForFilter

      public Common.VectorScalardata getScalarForFilter()
      .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;
      Specified by:
      getScalarForFilter in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The scalarForFilter.

    • getScalarForFilterOrBuilder

      public Common.VectorScalardataOrBuilder getScalarForFilterOrBuilder()
      .dingodb.pb.common.VectorScalardata scalar_for_filter = 21;
      Specified by:
      getScalarForFilterOrBuilder in interface Index.VectorScanQueryRequestOrBuilder

    • getTs

      public long getTs()
      int64 ts = 10;
      Specified by:
      getTs in interface Index.VectorScanQueryRequestOrBuilder
      Returns:
      The ts.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Index.VectorScanQueryRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Index.VectorScanQueryRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Index.VectorScanQueryRequest.Builder newBuilder()

    • newBuilder

      public static Index.VectorScanQueryRequest.Builder newBuilder(Index.VectorScanQueryRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Index.VectorScanQueryRequest getDefaultInstance()

    • parser

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

    • getParserForType

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