Send feedback
Class ReadOptions (2.13.4)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.13.4 keyboard_arrow_down
public final class ReadOptions extends GeneratedMessageV3 implements ReadOptionsOrBuilder
The options shared by read requests.
Protobuf type google.datastore.v1.ReadOptions
Static Fields
NEW_TRANSACTION_FIELD_NUMBER
public static final int NEW_TRANSACTION_FIELD_NUMBER
Field Value
READ_CONSISTENCY_FIELD_NUMBER
public static final int READ_CONSISTENCY_FIELD_NUMBER
Field Value
READ_TIME_FIELD_NUMBER
public static final int READ_TIME_FIELD_NUMBER
Field Value
TRANSACTION_FIELD_NUMBER
public static final int TRANSACTION_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static ReadOptions getDefaultInstance ()
Returns
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
newBuilder()
public static ReadOptions . Builder newBuilder ()
Returns
newBuilder(ReadOptions prototype)
public static ReadOptions . Builder newBuilder ( ReadOptions prototype )
Parameter
Returns
public static ReadOptions parseDelimitedFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ReadOptions parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static ReadOptions parseFrom ( byte [] data )
Parameter
Name Description databyte []
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static ReadOptions parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static ReadOptions parseFrom ( ByteString data )
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static ReadOptions parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadOptions parseFrom ( CodedInputStream input )
Parameter
Returns
Exceptions
public static ReadOptions parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
public static ReadOptions parseFrom ( InputStream input )
Parameter
Returns
Exceptions
public static ReadOptions parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static ReadOptions parseFrom ( ByteBuffer data )
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static ReadOptions parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Exceptions
parser()
public static Parser<ReadOptions> parser ()
Returns
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Returns
Overrides
getConsistencyTypeCase()
public ReadOptions . ConsistencyTypeCase getConsistencyTypeCase ()
Returns
getDefaultInstanceForType()
public ReadOptions getDefaultInstanceForType ()
Returns
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
or
RunQueryResponse.transaction .
.google.datastore.v1.TransactionOptions new_transaction = 3;
Returns
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
or
RunQueryResponse.transaction .
.google.datastore.v1.TransactionOptions new_transaction = 3;
Returns
getParserForType()
public Parser<ReadOptions> getParserForType ()
Returns
Overrides
getReadConsistency()
public ReadOptions . ReadConsistency getReadConsistency ()
The non-transactional read consistency to use.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
Returns
getReadConsistencyValue()
public int getReadConsistencyValue ()
The non-transactional read consistency to use.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
Returns
Type Description int The enum numeric value on the wire for readConsistency.
getReadTime()
public Timestamp getReadTime ()
Reads entities as they were at the given time. This may not be older
than 270 seconds. This value is only supported for Cloud Firestore in
Datastore mode.
.google.protobuf.Timestamp read_time = 4;
Returns
getReadTimeOrBuilder()
public TimestampOrBuilder getReadTimeOrBuilder ()
Reads entities as they were at the given time. This may not be older
than 270 seconds. This value is only supported for Cloud Firestore in
Datastore mode.
.google.protobuf.Timestamp read_time = 4;
Returns
getSerializedSize()
public int getSerializedSize ()
Returns
Overrides
getTransaction()
public ByteString getTransaction ()
The identifier of the transaction in which to read. A
transaction identifier is returned by a call to
Datastore.BeginTransaction .
bytes transaction = 2;
Returns
getUnknownFields()
public final UnknownFieldSet getUnknownFields ()
Returns
Overrides
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
or
RunQueryResponse.transaction .
.google.datastore.v1.TransactionOptions new_transaction = 3;
Returns
Type Description boolean Whether the newTransaction field is set.
hasReadConsistency()
public boolean hasReadConsistency ()
The non-transactional read consistency to use.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
Returns
Type Description boolean Whether the readConsistency field is set.
hasReadTime()
public boolean hasReadTime ()
Reads entities as they were at the given time. This may not be older
than 270 seconds. This value is only supported for Cloud Firestore in
Datastore mode.
.google.protobuf.Timestamp read_time = 4;
Returns
Type Description boolean Whether the readTime field is set.
hasTransaction()
public boolean hasTransaction ()
The identifier of the transaction in which to read. A
transaction identifier is returned by a call to
Datastore.BeginTransaction .
bytes transaction = 2;
Returns
Type Description boolean Whether the transaction field is set.
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
newBuilderForType()
public ReadOptions . Builder newBuilderForType ()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected ReadOptions . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Parameter
Returns
Overrides
toBuilder()
public ReadOptions . Builder toBuilder ()
Returns
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Parameter
Overrides
Exceptions
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
