Class QueryResultBatch (2.21.1)

public final class QueryResultBatch extends GeneratedMessageV3 implements QueryResultBatchOrBuilder

A batch of results produced by a query.

Protobuf type google.datastore.v1.QueryResultBatch

Static Fields

END_CURSOR_FIELD_NUMBER

public static final int END_CURSOR_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_RESULTS_FIELD_NUMBER

public static final int ENTITY_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

ENTITY_RESULT_TYPE_FIELD_NUMBER

public static final int ENTITY_RESULT_TYPE_FIELD_NUMBER
Field Value
Type Description
int

MORE_RESULTS_FIELD_NUMBER

public static final int MORE_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int

SKIPPED_CURSOR_FIELD_NUMBER

public static final int SKIPPED_CURSOR_FIELD_NUMBER
Field Value
Type Description
int

SKIPPED_RESULTS_FIELD_NUMBER

public static final int SKIPPED_RESULTS_FIELD_NUMBER
Field Value
Type Description
int

SNAPSHOT_VERSION_FIELD_NUMBER

public static final int SNAPSHOT_VERSION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static QueryResultBatch getDefaultInstance()
Returns
Type Description
QueryResultBatch

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static QueryResultBatch.Builder newBuilder()
Returns
Type Description
QueryResultBatch.Builder

newBuilder(QueryResultBatch prototype)

public static QueryResultBatch.Builder newBuilder(QueryResultBatch prototype)
Parameter
Name Description
prototype QueryResultBatch
Returns
Type Description
QueryResultBatch.Builder

parseDelimitedFrom(InputStream input)

public static QueryResultBatch parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryResultBatch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static QueryResultBatch parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static QueryResultBatch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static QueryResultBatch parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static QueryResultBatch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static QueryResultBatch parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryResultBatch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static QueryResultBatch parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static QueryResultBatch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static QueryResultBatch parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static QueryResultBatch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
QueryResultBatch
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<QueryResultBatch> parser()
Returns
Type Description
Parser<QueryResultBatch>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public QueryResultBatch getDefaultInstanceForType()
Returns
Type Description
QueryResultBatch

getEndCursor()

public ByteString getEndCursor()

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()

public EntityResult.ResultType getEntityResultType()

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()

public int getEntityResultTypeValue()

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)

public EntityResult getEntityResults(int index)

The results for this batch.

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

Parameter
Name Description
index int
Returns
Type Description
EntityResult

getEntityResultsCount()

public int getEntityResultsCount()

The results for this batch.

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

Returns
Type Description
int

getEntityResultsList()

public List<EntityResult> getEntityResultsList()

The results for this batch.

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

Returns
Type Description
List<EntityResult>

getEntityResultsOrBuilder(int index)

public EntityResultOrBuilder getEntityResultsOrBuilder(int index)

The results for this batch.

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

Parameter
Name Description
index int
Returns
Type Description
EntityResultOrBuilder

getEntityResultsOrBuilderList()

public List<? extends EntityResultOrBuilder> 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()

public QueryResultBatch.MoreResultsType getMoreResults()

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()

public int getMoreResultsValue()

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()

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

getReadTime()

public Timestamp getReadTime()

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()

public TimestampOrBuilder getReadTimeOrBuilder()

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()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSkippedCursor()

public ByteString getSkippedCursor()

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()

public int getSkippedResults()

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

int32 skipped_results = 6;

Returns
Type Description
int

The skippedResults.

getSnapshotVersion()

public long getSnapshotVersion()

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()

public boolean hasReadTime()

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()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public QueryResultBatch.Builder newBuilderForType()
Returns
Type Description
QueryResultBatch.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected QueryResultBatch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
QueryResultBatch.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public QueryResultBatch.Builder toBuilder()
Returns
Type Description
QueryResultBatch.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException