Package com.google.datastore.v1
Class QueryResultBatch
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.QueryResultBatch
- All Implemented Interfaces:
QueryResultBatchOrBuilder
,com.google.protobuf.Message
,com.google.protobuf.MessageLite
,com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
,Serializable
public final class QueryResultBatch
extends com.google.protobuf.GeneratedMessageV3
implements QueryResultBatchOrBuilder
A batch of results produced by a query.Protobuf type
google.datastore.v1.QueryResultBatch
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
A batch of results produced by a query.static enum
The possible values for the `more_results` field.Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,
BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessageLite.InternalOneOfEnum
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final int
static final int
static final int
Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields
Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize
Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static QueryResultBatch
static final com.google.protobuf.Descriptors.Descriptor
com.google.protobuf.ByteString
A cursor that points to the position after the last result in the batch.getEntityResults
(int index) The results for this batch.int
The results for this batch.The results for this batch.getEntityResultsOrBuilder
(int index) The results for this batch.List<? extends EntityResultOrBuilder>
The results for this batch.The result type for every entity in `entity_results`.int
The result type for every entity in `entity_results`.The state of the query after the current batch.int
The state of the query after the current batch.com.google.protobuf.Parser<QueryResultBatch>
com.google.protobuf.Timestamp
Read timestamp this batch was returned from.com.google.protobuf.TimestampOrBuilder
Read timestamp this batch was returned from.int
com.google.protobuf.ByteString
A cursor that points to the position after the last skipped result.int
The number of results skipped, typically because of an offset.long
The version number of the snapshot this batch was returned from.int
hashCode()
boolean
Read timestamp this batch was returned from.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
static QueryResultBatch.Builder
static QueryResultBatch.Builder
newBuilder
(QueryResultBatch prototype) protected QueryResultBatch.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static QueryResultBatch
parseDelimitedFrom
(InputStream input) static QueryResultBatch
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QueryResultBatch
parseFrom
(byte[] data) static QueryResultBatch
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QueryResultBatch
parseFrom
(com.google.protobuf.ByteString data) static QueryResultBatch
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QueryResultBatch
parseFrom
(com.google.protobuf.CodedInputStream input) static QueryResultBatch
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QueryResultBatch
parseFrom
(InputStream input) static QueryResultBatch
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static QueryResultBatch
parseFrom
(ByteBuffer data) static QueryResultBatch
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<QueryResultBatch>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo
Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
SKIPPED_RESULTS_FIELD_NUMBER
public static final int SKIPPED_RESULTS_FIELD_NUMBER- See Also:
-
SKIPPED_CURSOR_FIELD_NUMBER
public static final int SKIPPED_CURSOR_FIELD_NUMBER- See Also:
-
ENTITY_RESULT_TYPE_FIELD_NUMBER
public static final int ENTITY_RESULT_TYPE_FIELD_NUMBER- See Also:
-
ENTITY_RESULTS_FIELD_NUMBER
public static final int ENTITY_RESULTS_FIELD_NUMBER- See Also:
-
END_CURSOR_FIELD_NUMBER
public static final int END_CURSOR_FIELD_NUMBER- See Also:
-
MORE_RESULTS_FIELD_NUMBER
public static final int MORE_RESULTS_FIELD_NUMBER- See Also:
-
SNAPSHOT_VERSION_FIELD_NUMBER
public static final int SNAPSHOT_VERSION_FIELD_NUMBER- See Also:
-
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstance
in classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTable
in classcom.google.protobuf.GeneratedMessageV3
-
getSkippedResults
public int getSkippedResults()The number of results skipped, typically because of an offset.
int32 skipped_results = 6;
- Specified by:
getSkippedResults
in interfaceQueryResultBatchOrBuilder
- Returns:
- The skippedResults.
-
getSkippedCursor
public com.google.protobuf.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;
- Specified by:
getSkippedCursor
in interfaceQueryResultBatchOrBuilder
- Returns:
- The skippedCursor.
-
getEntityResultTypeValue
public int getEntityResultTypeValue()The result type for every entity in `entity_results`.
.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;
- Specified by:
getEntityResultTypeValue
in interfaceQueryResultBatchOrBuilder
- Returns:
- The enum numeric value on the wire for entityResultType.
-
getEntityResultType
The result type for every entity in `entity_results`.
.google.datastore.v1.EntityResult.ResultType entity_result_type = 1;
- Specified by:
getEntityResultType
in interfaceQueryResultBatchOrBuilder
- Returns:
- The entityResultType.
-
getEntityResultsList
The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
- Specified by:
getEntityResultsList
in interfaceQueryResultBatchOrBuilder
-
getEntityResultsOrBuilderList
The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
- Specified by:
getEntityResultsOrBuilderList
in interfaceQueryResultBatchOrBuilder
-
getEntityResultsCount
public int getEntityResultsCount()The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
- Specified by:
getEntityResultsCount
in interfaceQueryResultBatchOrBuilder
-
getEntityResults
The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
- Specified by:
getEntityResults
in interfaceQueryResultBatchOrBuilder
-
getEntityResultsOrBuilder
The results for this batch.
repeated .google.datastore.v1.EntityResult entity_results = 2;
- Specified by:
getEntityResultsOrBuilder
in interfaceQueryResultBatchOrBuilder
-
getEndCursor
public com.google.protobuf.ByteString getEndCursor()A cursor that points to the position after the last result in the batch.
bytes end_cursor = 4;
- Specified by:
getEndCursor
in interfaceQueryResultBatchOrBuilder
- Returns:
- The endCursor.
-
getMoreResultsValue
public int getMoreResultsValue()The state of the query after the current batch.
.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;
- Specified by:
getMoreResultsValue
in interfaceQueryResultBatchOrBuilder
- Returns:
- The enum numeric value on the wire for moreResults.
-
getMoreResults
The state of the query after the current batch.
.google.datastore.v1.QueryResultBatch.MoreResultsType more_results = 5;
- Specified by:
getMoreResults
in interfaceQueryResultBatchOrBuilder
- Returns:
- The moreResults.
-
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;
- Specified by:
getSnapshotVersion
in interfaceQueryResultBatchOrBuilder
- Returns:
- 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;
- Specified by:
hasReadTime
in interfaceQueryResultBatchOrBuilder
- Returns:
- Whether the readTime field is set.
-
getReadTime
public com.google.protobuf.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;
- Specified by:
getReadTime
in interfaceQueryResultBatchOrBuilder
- Returns:
- The readTime.
-
getReadTimeOrBuilder
public com.google.protobuf.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;
- Specified by:
getReadTimeOrBuilder
in interfaceQueryResultBatchOrBuilder
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitialized
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Overrides:
isInitialized
in classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeTo
in interfacecom.google.protobuf.MessageLite
- Overrides:
writeTo
in classcom.google.protobuf.GeneratedMessageV3
- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSize
in interfacecom.google.protobuf.MessageLite
- Overrides:
getSerializedSize
in classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equals
in interfacecom.google.protobuf.Message
- Overrides:
equals
in classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCode
in interfacecom.google.protobuf.Message
- Overrides:
hashCode
in classcom.google.protobuf.AbstractMessage
-
parseFrom
public static QueryResultBatch parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QueryResultBatch parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QueryResultBatch parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QueryResultBatch parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QueryResultBatch parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
public static QueryResultBatch parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException - Throws:
com.google.protobuf.InvalidProtocolBufferException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static QueryResultBatch parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static QueryResultBatch parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
public static QueryResultBatch parseFrom(com.google.protobuf.CodedInputStream input) throws IOException - Throws:
IOException
-
parseFrom
public static QueryResultBatch parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.Message
- Specified by:
newBuilderForType
in interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilder
in interfacecom.google.protobuf.Message
- Specified by:
toBuilder
in interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected QueryResultBatch.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForType
in interfacecom.google.protobuf.Message
- Specified by:
getParserForType
in interfacecom.google.protobuf.MessageLite
- Overrides:
getParserForType
in classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageLiteOrBuilder
- Specified by:
getDefaultInstanceForType
in interfacecom.google.protobuf.MessageOrBuilder
-