Package com.google.datastore.v1

Class 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:
    Serialized Form

    • Field Detail

      • SKIPPED_RESULTS_FIELD_NUMBER

        public static final int SKIPPED_RESULTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SKIPPED_CURSOR_FIELD_NUMBER

        public static final int SKIPPED_CURSOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTITY_RESULT_TYPE_FIELD_NUMBER

        public static final int ENTITY_RESULT_TYPE_FIELD_NUMBER
        See Also:
        Constant Field Values

      • ENTITY_RESULTS_FIELD_NUMBER

        public static final int ENTITY_RESULTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • END_CURSOR_FIELD_NUMBER

        public static final int END_CURSOR_FIELD_NUMBER
        See Also:
        Constant Field Values

      • MORE_RESULTS_FIELD_NUMBER

        public static final int MORE_RESULTS_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SNAPSHOT_VERSION_FIELD_NUMBER

        public static final int SNAPSHOT_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.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 class com.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 interface QueryResultBatchOrBuilder
        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 interface QueryResultBatchOrBuilder
        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 interface QueryResultBatchOrBuilder
        Returns:
        The enum numeric value on the wire for entityResultType.

      • 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 interface QueryResultBatchOrBuilder
        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 interface QueryResultBatchOrBuilder
        Returns:
        The enum numeric value on the wire for 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 interface QueryResultBatchOrBuilder
        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 interface QueryResultBatchOrBuilder
        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 interface QueryResultBatchOrBuilder
        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 interface QueryResultBatchOrBuilder

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.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

        public static QueryResultBatch parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public QueryResultBatch.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public QueryResultBatch.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected QueryResultBatch.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<QueryResultBatch> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public QueryResultBatch getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder