Interface QueryResultBatchOrBuilder (2.31.4)
Stay organized with collections
Save and categorize content based on your preferences.
publicinterface QueryResultBatchOrBuilderextendsMessageOrBuilderImplements
MessageOrBuilderMethods
getEndCursor()
publicabstractByteStringgetEndCursor()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()
publicabstractEntityResult.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()
publicabstractintgetEntityResultTypeValue() 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)
publicabstractEntityResultgetEntityResults(intindex)The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EntityResult |
|
getEntityResultsCount()
publicabstractintgetEntityResultsCount()The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
| Returns | |
|---|---|
| Type | Description |
int |
|
getEntityResultsList()
publicabstractList<EntityResult>getEntityResultsList()The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
| Returns | |
|---|---|
| Type | Description |
List<EntityResult> |
|
getEntityResultsOrBuilder(int index)
publicabstractEntityResultOrBuildergetEntityResultsOrBuilder(intindex)The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
EntityResultOrBuilder |
|
getEntityResultsOrBuilderList()
publicabstractList<?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()
publicabstractQueryResultBatch.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()
publicabstractintgetMoreResultsValue()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()
publicabstractTimestampgetReadTime() 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()
publicabstractTimestampOrBuildergetReadTimeOrBuilder() 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()
publicabstractByteStringgetSkippedCursor() 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()
publicabstractintgetSkippedResults()The number of results skipped, typically because of an offset.
int32 skipped_results = 6;
| Returns | |
|---|---|
| Type | Description |
int |
The skippedResults. |
getSnapshotVersion()
publicabstractlonggetSnapshotVersion() 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()
publicabstractbooleanhasReadTime() 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. |