Interface QueryResultBatchOrBuilder (2.13.4)

Version 2.13.4

• 2.24.3 (latest)
• 2.24.1
• 2.23.0
• 2.22.0
• 2.21.3
• 2.20.2
• 2.19.2
• 2.18.5
• 2.17.6

public interface QueryResultBatchOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndCursor()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract int getEntityResultsCount()

The results for this batch.

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

Returns

Type	Description
int

getEntityResultsList()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.

getReadTime()

public abstract 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 abstract 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

getSkippedCursor()

public abstract 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 abstract int getSkippedResults()

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

int32 skipped_results = 6;

Returns

Type	Description
int	The skippedResults.

getSnapshotVersion()

public abstract 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 abstract 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.