Class QueryResultBatch (2.33.0)

publicfinalclass QueryResultBatchextendsGeneratedMessageV3implementsQueryResultBatchOrBuilder

A batch of results produced by a query.

Protobuf type google.datastore.v1.QueryResultBatch

Inherited Members

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

Static Fields

END_CURSOR_FIELD_NUMBER

publicstaticfinalintEND_CURSOR_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_RESULTS_FIELD_NUMBER

publicstaticfinalintENTITY_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_RESULT_TYPE_FIELD_NUMBER

publicstaticfinalintENTITY_RESULT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

MORE_RESULTS_FIELD_NUMBER

publicstaticfinalintMORE_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

READ_TIME_FIELD_NUMBER

publicstaticfinalintREAD_TIME_FIELD_NUMBER
Field Value
Type Description
int

SKIPPED_CURSOR_FIELD_NUMBER

publicstaticfinalintSKIPPED_CURSOR_FIELD_NUMBER
Field Value
Type Description
int

SKIPPED_RESULTS_FIELD_NUMBER

publicstaticfinalintSKIPPED_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_VERSION_FIELD_NUMBER

publicstaticfinalintSNAPSHOT_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

publicstaticQueryResultBatchgetDefaultInstance()
Returns
Type Description
QueryResultBatch

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
Type Description
Descriptor

newBuilder()

publicstaticQueryResultBatch.BuildernewBuilder()
Returns
Type Description
QueryResultBatch.Builder

newBuilder(QueryResultBatch prototype)

publicstaticQueryResultBatch.BuildernewBuilder(QueryResultBatchprototype)
Parameter
Name Description
prototype QueryResultBatch
Returns
Type Description
QueryResultBatch.Builder

parseDelimitedFrom(InputStream input)

publicstaticQueryResultBatchparseDelimitedFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQueryResultBatchparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(byte[] data)

publicstaticQueryResultBatchparseFrom(byte[]data)
Parameter
Name Description
data byte[]
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticQueryResultBatchparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticQueryResultBatchparseFrom(ByteStringdata)
Parameter
Name Description
data ByteString
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticQueryResultBatchparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticQueryResultBatchparseFrom(CodedInputStreaminput)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQueryResultBatchparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input)

publicstaticQueryResultBatchparseFrom(InputStreaminput)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticQueryResultBatchparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

publicstaticQueryResultBatchparseFrom(ByteBufferdata)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticQueryResultBatchparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parser()

publicstaticParser<QueryResultBatch>parser()
Returns
Type Description
Parser<QueryResultBatch>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

publicQueryResultBatchgetDefaultInstanceForType()
Returns
Type Description
QueryResultBatch

getEndCursor()

publicByteStringgetEndCursor()

A cursor that points to the position after the last result in the batch.

bytes end_cursor = 4;

Returns
Type Description
ByteString

The endCursor.

getEntityResultType()

publicEntityResult.ResultTypegetEntityResultType()

The result type for every entity in entity_results.

.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;

Returns
Type Description
EntityResult.ResultType

The entityResultType.

getEntityResultTypeValue()

publicintgetEntityResultTypeValue()

The result type for every entity in entity_results.

.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;

Returns
Type Description
int

The enum numeric value on the wire for entityResultType.

getEntityResults(int index)

publicEntityResultgetEntityResults(intindex)

The results for this batch.

repeated .google.datastore.v1.EntityResult entity_results = 2;

Parameter
Name Description
index int
Returns
Type Description
EntityResult

getEntityResultsCount()

publicintgetEntityResultsCount()

The results for this batch.

repeated .google.datastore.v1.EntityResult entity_results = 2;

Returns
Type Description
int

getEntityResultsList()

publicList<EntityResult>getEntityResultsList()

The results for this batch.

repeated .google.datastore.v1.EntityResult entity_results = 2;

Returns
Type Description
List<EntityResult>

getEntityResultsOrBuilder(int index)

publicEntityResultOrBuildergetEntityResultsOrBuilder(intindex)

The results for this batch.

repeated .google.datastore.v1.EntityResult entity_results = 2;

Parameter
Name Description
index int
Returns
Type Description
EntityResultOrBuilder

getEntityResultsOrBuilderList()

publicList<?extendsEntityResultOrBuilder>getEntityResultsOrBuilderList()

The results for this batch.

repeated .google.datastore.v1.EntityResult entity_results = 2;

Returns
Type Description
List<? extends com.google.datastore.v1.EntityResultOrBuilder>

getMoreResults()

publicQueryResultBatch.MoreResultsTypegetMoreResults()

The state of the query after the current batch.

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;

Returns
Type Description
QueryResultBatch.MoreResultsType

The moreResults.

getMoreResultsValue()

publicintgetMoreResultsValue()

The state of the query after the current batch.

.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;

Returns
Type Description
int

The enum numeric value on the wire for moreResults.

getParserForType()

publicParser<QueryResultBatch>getParserForType()
Returns
Type Description
Parser<QueryResultBatch>
Overrides

getReadTime()

publicTimestampgetReadTime()

Read timestamp this batch was returned from. This applies to the range of results from the query's start_cursor (or the beginning of the query if no cursor was given) to this batch's end_cursor (not the query's end_cursor).

In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore.

.google.protobuf.Timestamp read_time = 8;

Returns
Type Description
Timestamp

The readTime.

getReadTimeOrBuilder()

publicTimestampOrBuildergetReadTimeOrBuilder()

Read timestamp this batch was returned from. This applies to the range of results from the query's start_cursor (or the beginning of the query if no cursor was given) to this batch's end_cursor (not the query's end_cursor).

In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore.

.google.protobuf.Timestamp read_time = 8;

Returns
Type Description
TimestampOrBuilder

getSerializedSize()

publicintgetSerializedSize()
Returns
Type Description
int
Overrides

getSkippedCursor()

publicByteStringgetSkippedCursor()

A cursor that points to the position after the last skipped result. Will be set when skipped_results != 0.

bytes skipped_cursor = 3;

Returns
Type Description
ByteString

The skippedCursor.

getSkippedResults()

publicintgetSkippedResults()

The number of results skipped, typically because of an offset.

int32 skipped_results = 6;

Returns
Type Description
int

The skippedResults.

getSnapshotVersion()

publiclonggetSnapshotVersion()

The version number of the snapshot this batch was returned from. This applies to the range of results from the query's start_cursor (or the beginning of the query if no cursor was given) to this batch's end_cursor (not the query's end_cursor).

In a single transaction, subsequent query result batches for the same query can have a greater snapshot version number. Each batch's snapshot version is valid for all preceding batches. The value will be zero for eventually consistent queries.

int64 snapshot_version = 7;

Returns
Type Description
long

The snapshotVersion.

hasReadTime()

publicbooleanhasReadTime()

Read timestamp this batch was returned from. This applies to the range of results from the query's start_cursor (or the beginning of the query if no cursor was given) to this batch's end_cursor (not the query's end_cursor).

In a single transaction, subsequent query result batches for the same query can have a greater timestamp. Each batch's read timestamp is valid for all preceding batches. This value will not be set for eventually consistent queries in Cloud Datastore.

.google.protobuf.Timestamp read_time = 8;

Returns
Type Description
boolean

Whether the readTime field is set.

hashCode()

publicinthashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

publicQueryResultBatch.BuildernewBuilderForType()
Returns
Type Description
QueryResultBatch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedQueryResultBatch.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueryResultBatch.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

publicQueryResultBatch.BuildertoBuilder()
Returns
Type Description
QueryResultBatch.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.