Google Cloud Datastore v1 API - Class QueryResultBatch (4.5.0) 

public sealed class QueryResultBatch : IMessage<QueryResultBatch>, IEquatable<QueryResultBatch>, IDeepCloneable<QueryResultBatch>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Datastore v1 API class QueryResultBatch.

A batch of results produced by a query.

Inheritance

object > QueryResultBatch

Namespace

GoogleCloudGoogle.Cloud.DatastoreV1

Assembly

Google.Cloud.Datastore.V1.dll

Constructors

QueryResultBatch()

public QueryResultBatch()

QueryResultBatch(QueryResultBatch)

public QueryResultBatch(QueryResultBatch other)
Parameter
NameDescription
otherQueryResultBatch

Properties

EndCursor

public ByteString EndCursor { get; set; }

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

Property Value
TypeDescription
ByteString

EntityResults

public RepeatedField<EntityResult> EntityResults { get; }

The results for this batch.

Property Value
TypeDescription
RepeatedFieldEntityResult

EntityResultType

public EntityResult.Types.ResultType EntityResultType { get; set; }

The result type for every entity in entity_results.

Property Value
TypeDescription
EntityResultTypesResultType

MoreResults

public QueryResultBatch.Types.MoreResultsType MoreResults { get; set; }

The state of the query after the current batch.

Property Value
TypeDescription
QueryResultBatchTypesMoreResultsType

ReadTime

public Timestamp ReadTime { get; set; }

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.

Property Value
TypeDescription
Timestamp

SkippedCursor

public ByteString SkippedCursor { get; set; }

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

Property Value
TypeDescription
ByteString

SkippedResults

public int SkippedResults { get; set; }

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

Property Value
TypeDescription
int

SnapshotVersion

public long SnapshotVersion { get; set; }

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.

Property Value
TypeDescription
long