Package io.dingodb.store

Class Store.KvScanBeginRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.dingodb.store.Store.KvScanBeginRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Store.KvScanBeginRequestOrBuilder, Serializable
Enclosing class:
Store
public static final class Store.KvScanBeginRequest extends com.google.protobuf.GeneratedMessageV3 implements Store.KvScanBeginRequestOrBuilder
Protobuf type dingodb.pb.store.KvScanBeginRequest
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:

    • RANGE_FIELD_NUMBER

      public static final int RANGE_FIELD_NUMBER
      See Also:

    • MAX_FETCH_CNT_FIELD_NUMBER

      public static final int MAX_FETCH_CNT_FIELD_NUMBER
      See Also:

    • KEY_ONLY_FIELD_NUMBER

      public static final int KEY_ONLY_FIELD_NUMBER
      See Also:

    • DISABLE_AUTO_RELEASE_FIELD_NUMBER

      public static final int DISABLE_AUTO_RELEASE_FIELD_NUMBER
      See Also:

    • DISABLE_COPROCESSOR_FIELD_NUMBER

      public static final int DISABLE_COPROCESSOR_FIELD_NUMBER
      See Also:

    • COPROCESSOR_FIELD_NUMBER

      public static final int COPROCESSOR_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 Store.KvScanBeginRequestOrBuilder
      Returns:
      Whether the requestInfo field is set.

    • getRequestInfo

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

    • getRequestInfoOrBuilder

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

    • hasContext

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

    • getContext

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

    • getContextOrBuilder

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

    • hasRange

      public boolean hasRange()
       prefix start_key end_key with mode
      .dingodb.pb.common.RangeWithOptions range = 3;
      Specified by:
      hasRange in interface Store.KvScanBeginRequestOrBuilder
      Returns:
      Whether the range field is set.

    • getRange

      public Common.RangeWithOptions getRange()
       prefix start_key end_key with mode
      .dingodb.pb.common.RangeWithOptions range = 3;
      Specified by:
      getRange in interface Store.KvScanBeginRequestOrBuilder
      Returns:
      The range.

    • getRangeOrBuilder

      public Common.RangeWithOptionsOrBuilder getRangeOrBuilder()
       prefix start_key end_key with mode
      .dingodb.pb.common.RangeWithOptions range = 3;
      Specified by:
      getRangeOrBuilder in interface Store.KvScanBeginRequestOrBuilder

    • getMaxFetchCnt

      public long getMaxFetchCnt()
       The maximum number of requests keys per request
 limit = 0 means only scan_id is returned and no data is returned
 If max_fetch_cnt > 0, it means to return scan_id and data. Note that in this way, the return will be slower because
 the data needs to be prepared For example: max_fetch_cnt = 10000, which means that the maximum number of kv items
 in this request is 10000, which is just a suggested value. If the maximum number of kv items in the server is 1000,
 The data returned each time is only 1000 pieces of data. Note: only the maximum number of kv pairs per request
      int64 max_fetch_cnt = 4;
      Specified by:
      getMaxFetchCnt in interface Store.KvScanBeginRequestOrBuilder
      Returns:
      The maxFetchCnt.

    • getKeyOnly

      public boolean getKeyOnly()
       is it just to get the key
      bool key_only = 5;
      Specified by:
      getKeyOnly in interface Store.KvScanBeginRequestOrBuilder
      Returns:
      The keyOnly.

    • getDisableAutoRelease

      public boolean getDisableAutoRelease()
       whether to automatically release resources
 after reading all the data, the default is false,
 and the default is automatically released
      bool disable_auto_release = 6;
      Specified by:
      getDisableAutoRelease in interface Store.KvScanBeginRequestOrBuilder
      Returns:
      The disableAutoRelease.

    • getDisableCoprocessor

      public boolean getDisableCoprocessor()
       Whether to enable operator pushdown, enabled by default (false: means enabled, true: means disabled)
      bool disable_coprocessor = 7;
      Specified by:
      getDisableCoprocessor in interface Store.KvScanBeginRequestOrBuilder
      Returns:
      The disableCoprocessor.

    • hasCoprocessor

      public boolean hasCoprocessor()
       coprocessor
      .dingodb.pb.store.Coprocessor coprocessor = 8;
      Specified by:
      hasCoprocessor in interface Store.KvScanBeginRequestOrBuilder
      Returns:
      Whether the coprocessor field is set.

    • getCoprocessor

      public Store.Coprocessor getCoprocessor()
       coprocessor
      .dingodb.pb.store.Coprocessor coprocessor = 8;
      Specified by:
      getCoprocessor in interface Store.KvScanBeginRequestOrBuilder
      Returns:
      The coprocessor.

    • getCoprocessorOrBuilder

      public Store.CoprocessorOrBuilder getCoprocessorOrBuilder()
       coprocessor
      .dingodb.pb.store.Coprocessor coprocessor = 8;
      Specified by:
      getCoprocessorOrBuilder in interface Store.KvScanBeginRequestOrBuilder

    • getTs

      public long getTs()
      int64 ts = 9;
      Specified by:
      getTs in interface Store.KvScanBeginRequestOrBuilder
      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 Store.KvScanBeginRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Store.KvScanBeginRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Store.KvScanBeginRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Store.KvScanBeginRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

      public static Store.KvScanBeginRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Store.KvScanBeginRequest.Builder newBuilder()

    • newBuilder

      public static Store.KvScanBeginRequest.Builder newBuilder(Store.KvScanBeginRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Store.KvScanBeginRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Store.KvScanBeginRequest> parser()

    • getParserForType

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