public final class QueryResultBatch extends GeneratedMessageV3 implements QueryResultBatchOrBuilder
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
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static QueryResultBatch.Builder newBuilder()
newBuilder(QueryResultBatch prototype)
public static QueryResultBatch.Builder newBuilder(QueryResultBatch prototype)
public static QueryResultBatch parseDelimitedFrom(InputStream input)
public static QueryResultBatch parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static QueryResultBatch parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static QueryResultBatch parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static QueryResultBatch parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryResultBatch parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static QueryResultBatch parseFrom(CodedInputStream input)
public static QueryResultBatch parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static QueryResultBatch parseFrom(InputStream input)
public static QueryResultBatch parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static QueryResultBatch parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static QueryResultBatch parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<QueryResultBatch> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public QueryResultBatch getDefaultInstanceForType()
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;
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
|
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;
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
|
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;
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()
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;
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public QueryResultBatch.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected QueryResultBatch.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public QueryResultBatch.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
