Package io.dingodb.document

Interface Document.DocumentScanQueryRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Document.DocumentScanQueryRequest, Document.DocumentScanQueryRequest.Builder
Enclosing class:
Document
public static interface Document.DocumentScanQueryRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    Store.Context
    getContext()
    .dingodb.pb.store.Context context = 2;
    Store.ContextOrBuilder
    getContextOrBuilder()
    .dingodb.pb.store.Context context = 2;
    long
    getDocumentIdEnd()
    int64 document_id_end = 6;
    long
    getDocumentIdStart()
    int64 document_id_start = 3;
    boolean
    getIsReverseScan()
    bool is_reverse_scan = 4;
    long
    getMaxScanCount()
    the max count user want to scan
    Common.RequestInfo
    getRequestInfo()
    .dingodb.pb.common.RequestInfo request_info = 1;
    Common.RequestInfoOrBuilder
    getRequestInfoOrBuilder()
    .dingodb.pb.common.RequestInfo request_info = 1;
    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.
    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.
    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.
    List<String>
    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.
    long
    getTs()
    int64 ts = 20;
    boolean
    getWithoutScalarData()
    Default false, if true, response without scalar data.
    boolean
    getWithoutTableData()
    Default false, if true, response without table data.
    boolean
    hasContext()
    .dingodb.pb.store.Context context = 2;
    boolean
    hasRequestInfo()
    .dingodb.pb.common.RequestInfo request_info = 1;

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • hasRequestInfo

      boolean hasRequestInfo()
      .dingodb.pb.common.RequestInfo request_info = 1;
      Returns:
      Whether the requestInfo field is set.

    • getRequestInfo

      Common.RequestInfo getRequestInfo()
      .dingodb.pb.common.RequestInfo request_info = 1;
      Returns:
      The requestInfo.

    • getRequestInfoOrBuilder

      Common.RequestInfoOrBuilder getRequestInfoOrBuilder()
      .dingodb.pb.common.RequestInfo request_info = 1;

    • hasContext

      boolean hasContext()
      .dingodb.pb.store.Context context = 2;
      Returns:
      Whether the context field is set.

    • getContext

      Store.Context getContext()
      .dingodb.pb.store.Context context = 2;
      Returns:
      The context.

    • getContextOrBuilder

      Store.ContextOrBuilder getContextOrBuilder()
      .dingodb.pb.store.Context context = 2;

    • getDocumentIdStart

      long getDocumentIdStart()
      int64 document_id_start = 3;
      Returns:
      The documentIdStart.

    • getIsReverseScan

      boolean getIsReverseScan()
      bool is_reverse_scan = 4;
      Returns:
      The isReverseScan.

    • getMaxScanCount

      long getMaxScanCount()
       the max count user want to scan
      int64 max_scan_count = 5;
      Returns:
      The maxScanCount.

    • getDocumentIdEnd

      long getDocumentIdEnd()
      int64 document_id_end = 6;
      Returns:
      The documentIdEnd.

    • getWithoutScalarData

      boolean getWithoutScalarData()
       Default false, if true, response without scalar data.
      bool without_scalar_data = 12;
      Returns:
      The withoutScalarData.

    • getSelectedKeysList

      List<String> 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;
      Returns:
      A list containing the selectedKeys.

    • getSelectedKeysCount

      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;
      Returns:
      The count of selectedKeys.

    • getSelectedKeys

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The selectedKeys at the given index.

    • getSelectedKeysBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the selectedKeys at the given index.

    • getWithoutTableData

      boolean getWithoutTableData()
       Default false, if true, response without table data.
      bool without_table_data = 14;
      Returns:
      The withoutTableData.

    • getTs

      long getTs()
      int64 ts = 20;
      Returns:
      The ts.