Package com.google.datastore.v1

Class ReadOptions

  • All Implemented Interfaces:
    ReadOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class ReadOptions
extends com.google.protobuf.GeneratedMessageV3
implements ReadOptionsOrBuilder
     The options shared by read requests.
    Protobuf type google.datastore.v1.ReadOptions
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ReadOptions.Builder
      The options shared by read requests.
      static class  ReadOptions.ConsistencyTypeCase  
      static class  ReadOptions.ReadConsistency
      The possible values for read consistencies.

      • 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 Detail

      • READ_CONSISTENCY_FIELD_NUMBER

        public static final int READ_CONSISTENCY_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRANSACTION_FIELD_NUMBER

        public static final int TRANSACTION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • NEW_TRANSACTION_FIELD_NUMBER

        public static final int NEW_TRANSACTION_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

      • hasReadConsistency

        public boolean hasReadConsistency()
         The non-transactional read consistency to use.
        .google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
        Specified by:
        hasReadConsistency in interface ReadOptionsOrBuilder
        Returns:
        Whether the readConsistency field is set.

      • getReadConsistencyValue

        public int getReadConsistencyValue()
         The non-transactional read consistency to use.
        .google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
        Specified by:
        getReadConsistencyValue in interface ReadOptionsOrBuilder
        Returns:
        The enum numeric value on the wire for readConsistency.

      • hasTransaction

        public boolean hasTransaction()
         The identifier of the transaction in which to read. A
 transaction identifier is returned by a call to
 [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
        bytes transaction = 2;
        Specified by:
        hasTransaction in interface ReadOptionsOrBuilder
        Returns:
        Whether the transaction field is set.

      • getTransaction

        public com.google.protobuf.ByteString getTransaction()
         The identifier of the transaction in which to read. A
 transaction identifier is returned by a call to
 [Datastore.BeginTransaction][google.datastore.v1.Datastore.BeginTransaction].
        bytes transaction = 2;
        Specified by:
        getTransaction in interface ReadOptionsOrBuilder
        Returns:
        The transaction.

      • hasNewTransaction

        public boolean hasNewTransaction()
         Options for beginning a new transaction for this request.

 The new transaction identifier will be returned in the corresponding
 response as either
 [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction]
 or
 [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].
        .google.datastore.v1.TransactionOptions new_transaction = 3;
        Specified by:
        hasNewTransaction in interface ReadOptionsOrBuilder
        Returns:
        Whether the newTransaction field is set.

      • getNewTransaction

        public TransactionOptions getNewTransaction()
         Options for beginning a new transaction for this request.

 The new transaction identifier will be returned in the corresponding
 response as either
 [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction]
 or
 [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].
        .google.datastore.v1.TransactionOptions new_transaction = 3;
        Specified by:
        getNewTransaction in interface ReadOptionsOrBuilder
        Returns:
        The newTransaction.

      • getNewTransactionOrBuilder

        public TransactionOptionsOrBuilder getNewTransactionOrBuilder()
         Options for beginning a new transaction for this request.

 The new transaction identifier will be returned in the corresponding
 response as either
 [LookupResponse.transaction][google.datastore.v1.LookupResponse.transaction]
 or
 [RunQueryResponse.transaction][google.datastore.v1.RunQueryResponse.transaction].
        .google.datastore.v1.TransactionOptions new_transaction = 3;
        Specified by:
        getNewTransactionOrBuilder in interface ReadOptionsOrBuilder

      • hasReadTime

        public boolean hasReadTime()
         Reads entities as they were at the given time. This value is only
 supported for Cloud Firestore in Datastore mode.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
        .google.protobuf.Timestamp read_time = 4;
        Specified by:
        hasReadTime in interface ReadOptionsOrBuilder
        Returns:
        Whether the readTime field is set.

      • getReadTime

        public com.google.protobuf.Timestamp getReadTime()
         Reads entities as they were at the given time. This value is only
 supported for Cloud Firestore in Datastore mode.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
        .google.protobuf.Timestamp read_time = 4;
        Specified by:
        getReadTime in interface ReadOptionsOrBuilder
        Returns:
        The readTime.

      • getReadTimeOrBuilder

        public com.google.protobuf.TimestampOrBuilder getReadTimeOrBuilder()
         Reads entities as they were at the given time. This value is only
 supported for Cloud Firestore in Datastore mode.

 This must be a microsecond precision timestamp within the past one hour,
 or if Point-in-Time Recovery is enabled, can additionally be a whole
 minute timestamp within the past 7 days.
        .google.protobuf.Timestamp read_time = 4;
        Specified by:
        getReadTimeOrBuilder in interface ReadOptionsOrBuilder

      • 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 ReadOptions parseFrom​(ByteBuffer data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadOptions parseFrom​(ByteBuffer data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadOptions parseFrom​(com.google.protobuf.ByteString data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadOptions parseFrom​(com.google.protobuf.ByteString data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadOptions parseFrom​(byte[] data)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ReadOptions parseFrom​(byte[] data,
                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                             throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

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

      • getDefaultInstance

        public static ReadOptions getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<ReadOptions> parser()

      • getParserForType

        public com.google.protobuf.Parser<ReadOptions> 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 ReadOptions getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder