Package io.dingodb.document

Class Document.DocumentScanQueryRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

io.dingodb.document.Document.DocumentScanQueryRequest

All Implemented Interfaces:

com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Document.DocumentScanQueryRequestOrBuilder, Serializable

Enclosing class:

Document

public static final class Document.DocumentScanQueryRequest
extends com.google.protobuf.GeneratedMessageV3
implements Document.DocumentScanQueryRequestOrBuilder

Protobuf type dingodb.pb.document.DocumentScanQueryRequest

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	Document.DocumentScanQueryRequest.Builder	Protobuf type dingodb.pb.document.DocumentScanQueryRequest

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CONTEXT_FIELD_NUMBER
static final int	DOCUMENT_ID_END_FIELD_NUMBER
static final int	DOCUMENT_ID_START_FIELD_NUMBER
static final int	IS_REVERSE_SCAN_FIELD_NUMBER
static final int	MAX_SCAN_COUNT_FIELD_NUMBER
static final int	REQUEST_INFO_FIELD_NUMBER
static final int	SELECTED_KEYS_FIELD_NUMBER
static final int	TS_FIELD_NUMBER
static final int	WITHOUT_SCALAR_DATA_FIELD_NUMBER
static final int	WITHOUT_TABLE_DATA_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
Store.Context	getContext()	.dingodb.pb.store.Context context = 2;
Store.ContextOrBuilder	getContextOrBuilder()	.dingodb.pb.store.Context context = 2;
static Document.DocumentScanQueryRequest	getDefaultInstance()
Document.DocumentScanQueryRequest	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
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
com.google.protobuf.Parser<Document.DocumentScanQueryRequest>	getParserForType()
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.
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.
int	getSerializedSize()
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;
int	hashCode()
boolean	hasRequestInfo()	.dingodb.pb.common.RequestInfo request_info = 1;
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
static Document.DocumentScanQueryRequest.Builder	newBuilder()
static Document.DocumentScanQueryRequest.Builder	newBuilder(Document.DocumentScanQueryRequest prototype)
Document.DocumentScanQueryRequest.Builder	newBuilderForType()
protected Document.DocumentScanQueryRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Document.DocumentScanQueryRequest	parseDelimitedFrom(InputStream input)
static Document.DocumentScanQueryRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentScanQueryRequest	parseFrom(byte[] data)
static Document.DocumentScanQueryRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentScanQueryRequest	parseFrom(com.google.protobuf.ByteString data)
static Document.DocumentScanQueryRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentScanQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static Document.DocumentScanQueryRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentScanQueryRequest	parseFrom(InputStream input)
static Document.DocumentScanQueryRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Document.DocumentScanQueryRequest	parseFrom(ByteBuffer data)
static Document.DocumentScanQueryRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Document.DocumentScanQueryRequest>	parser()
Document.DocumentScanQueryRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Field Details

REQUEST_INFO_FIELD_NUMBER

public static final int REQUEST_INFO_FIELD_NUMBER

See Also:

• Constant Field Values

CONTEXT_FIELD_NUMBER

public static final int CONTEXT_FIELD_NUMBER

See Also:

• Constant Field Values

DOCUMENT_ID_START_FIELD_NUMBER

public static final int DOCUMENT_ID_START_FIELD_NUMBER

See Also:

• Constant Field Values

IS_REVERSE_SCAN_FIELD_NUMBER

public static final int IS_REVERSE_SCAN_FIELD_NUMBER

See Also:

• Constant Field Values

MAX_SCAN_COUNT_FIELD_NUMBER

public static final int MAX_SCAN_COUNT_FIELD_NUMBER

See Also:

• Constant Field Values

DOCUMENT_ID_END_FIELD_NUMBER

public static final int DOCUMENT_ID_END_FIELD_NUMBER

See Also:

• Constant Field Values

WITHOUT_SCALAR_DATA_FIELD_NUMBER

public static final int WITHOUT_SCALAR_DATA_FIELD_NUMBER

See Also:

• Constant Field Values

SELECTED_KEYS_FIELD_NUMBER

public static final int SELECTED_KEYS_FIELD_NUMBER

See Also:

• Constant Field Values

WITHOUT_TABLE_DATA_FIELD_NUMBER

public static final int WITHOUT_TABLE_DATA_FIELD_NUMBER

See Also:

• Constant Field Values

TS_FIELD_NUMBER

public static final int TS_FIELD_NUMBER

See Also:

• Constant Field Values

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 Document.DocumentScanQueryRequestOrBuilder

Returns:

Whether the requestInfo field is set.

getRequestInfo

public Common.RequestInfo getRequestInfo()

.dingodb.pb.common.RequestInfo request_info = 1;

Specified by:

getRequestInfo in interface Document.DocumentScanQueryRequestOrBuilder

Returns:

The requestInfo.

getRequestInfoOrBuilder

public Common.RequestInfoOrBuilder getRequestInfoOrBuilder()

.dingodb.pb.common.RequestInfo request_info = 1;

Specified by:

getRequestInfoOrBuilder in interface Document.DocumentScanQueryRequestOrBuilder

hasContext

public boolean hasContext()

.dingodb.pb.store.Context context = 2;

Specified by:

hasContext in interface Document.DocumentScanQueryRequestOrBuilder

Returns:

Whether the context field is set.

getContext

public Store.Context getContext()

.dingodb.pb.store.Context context = 2;

Specified by:

getContext in interface Document.DocumentScanQueryRequestOrBuilder

Returns:

The context.

getContextOrBuilder

public Store.ContextOrBuilder getContextOrBuilder()

.dingodb.pb.store.Context context = 2;

Specified by:

getContextOrBuilder in interface Document.DocumentScanQueryRequestOrBuilder

getDocumentIdStart

public long getDocumentIdStart()

int64 document_id_start = 3;

Specified by:

getDocumentIdStart in interface Document.DocumentScanQueryRequestOrBuilder

Returns:

The documentIdStart.

getIsReverseScan

public boolean getIsReverseScan()

bool is_reverse_scan = 4;

Specified by:

getIsReverseScan in interface Document.DocumentScanQueryRequestOrBuilder

Returns:

The isReverseScan.

getMaxScanCount

public long getMaxScanCount()

 the max count user want to scan
 

int64 max_scan_count = 5;

Specified by:

getMaxScanCount in interface Document.DocumentScanQueryRequestOrBuilder

Returns:

The maxScanCount.

getDocumentIdEnd

public long getDocumentIdEnd()

int64 document_id_end = 6;

Specified by:

getDocumentIdEnd in interface Document.DocumentScanQueryRequestOrBuilder

Returns:

The documentIdEnd.

getWithoutScalarData

public boolean getWithoutScalarData()

 Default false, if true, response without scalar data.
 

bool without_scalar_data = 12;

Specified by:

getWithoutScalarData in interface Document.DocumentScanQueryRequestOrBuilder

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 Document.DocumentScanQueryRequestOrBuilder

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 Document.DocumentScanQueryRequestOrBuilder

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 Document.DocumentScanQueryRequestOrBuilder

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 Document.DocumentScanQueryRequestOrBuilder

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 Document.DocumentScanQueryRequestOrBuilder

Returns:

The withoutTableData.

getTs

public long getTs()

int64 ts = 20;

Specified by:

getTs in interface Document.DocumentScanQueryRequestOrBuilder

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 Document.DocumentScanQueryRequest parseFrom(ByteBuffer data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(ByteBuffer data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(com.google.protobuf.ByteString data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(com.google.protobuf.ByteString data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(byte[] data)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(byte[] data,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(InputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.DocumentScanQueryRequest parseDelimitedFrom(InputStream input)
                                                            throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document.DocumentScanQueryRequest parseDelimitedFrom(InputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                            throws IOException

Throws:

IOException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                                   throws IOException

Throws:

IOException

parseFrom

public static Document.DocumentScanQueryRequest parseFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                   throws IOException

Throws:

IOException

newBuilderForType

public Document.DocumentScanQueryRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Document.DocumentScanQueryRequest.Builder newBuilder()

newBuilder

public static Document.DocumentScanQueryRequest.Builder newBuilder(Document.DocumentScanQueryRequest prototype)

toBuilder

public Document.DocumentScanQueryRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Document.DocumentScanQueryRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Document.DocumentScanQueryRequest getDefaultInstance()

parser

public static com.google.protobuf.Parser<Document.DocumentScanQueryRequest> parser()

getParserForType

public com.google.protobuf.Parser<Document.DocumentScanQueryRequest> 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 Document.DocumentScanQueryRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder