Package com.google.datastore.v1
Class ReadOptions
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.datastore.v1.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:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic final class
The options shared by read requests.static enum
static enum
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 Summary
Modifier and TypeFieldDescriptionstatic 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 ReadOptions
static final com.google.protobuf.Descriptors.Descriptor
Options for beginning a new transaction for this request.Options for beginning a new transaction for this request.com.google.protobuf.Parser<ReadOptions>
The non-transactional read consistency to use.int
The non-transactional read consistency to use.com.google.protobuf.Timestamp
Reads entities as they were at the given time.com.google.protobuf.TimestampOrBuilder
Reads entities as they were at the given time.int
com.google.protobuf.ByteString
The identifier of the transaction in which to read.int
hashCode()
boolean
Options for beginning a new transaction for this request.boolean
The non-transactional read consistency to use.boolean
Reads entities as they were at the given time.boolean
The identifier of the transaction in which to read.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
final boolean
static ReadOptions.Builder
static ReadOptions.Builder
newBuilder
(ReadOptions prototype) protected ReadOptions.Builder
newBuilderForType
(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected Object
newInstance
(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static ReadOptions
parseDelimitedFrom
(InputStream input) static ReadOptions
parseDelimitedFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadOptions
parseFrom
(byte[] data) static ReadOptions
parseFrom
(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadOptions
parseFrom
(com.google.protobuf.ByteString data) static ReadOptions
parseFrom
(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadOptions
parseFrom
(com.google.protobuf.CodedInputStream input) static ReadOptions
parseFrom
(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadOptions
parseFrom
(InputStream input) static ReadOptions
parseFrom
(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static ReadOptions
parseFrom
(ByteBuffer data) static ReadOptions
parseFrom
(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<ReadOptions>
parser()
void
writeTo
(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, 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
-
READ_CONSISTENCY_FIELD_NUMBER
public static final int READ_CONSISTENCY_FIELD_NUMBER- See Also:
-
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER- See Also:
-
NEW_TRANSACTION_FIELD_NUMBER
public static final int NEW_TRANSACTION_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
-
getConsistencyTypeCase
- Specified by:
getConsistencyTypeCase
in interfaceReadOptionsOrBuilder
-
hasReadConsistency
public boolean hasReadConsistency()The non-transactional read consistency to use.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
- Specified by:
hasReadConsistency
in interfaceReadOptionsOrBuilder
- 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 interfaceReadOptionsOrBuilder
- Returns:
- The enum numeric value on the wire for readConsistency.
-
getReadConsistency
The non-transactional read consistency to use.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
- Specified by:
getReadConsistency
in interfaceReadOptionsOrBuilder
- Returns:
- The 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 interfaceReadOptionsOrBuilder
- 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 interfaceReadOptionsOrBuilder
- 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 interfaceReadOptionsOrBuilder
- Returns:
- Whether the newTransaction field is set.
-
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 interfaceReadOptionsOrBuilder
- Returns:
- The newTransaction.
-
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 interfaceReadOptionsOrBuilder
-
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 interfaceReadOptionsOrBuilder
- 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 interfaceReadOptionsOrBuilder
- 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 interfaceReadOptionsOrBuilder
-
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 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
- Throws:
IOException
-
parseFrom
public static ReadOptions parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static ReadOptions parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static ReadOptions 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 ReadOptions.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
-