Send feedback
Class ReadOptions.Builder (2.4.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.4.0 keyboard_arrow_down
public static final class ReadOptions . Builder extends GeneratedMessageV3 . Builder<ReadOptions . Builder > implements ReadOptionsOrBuilder
The options shared by read requests.
Protobuf type google.datastore.v1.ReadOptions
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ReadOptions . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
build()
public ReadOptions build ()
Returns
buildPartial()
public ReadOptions buildPartial ()
Returns
clear()
public ReadOptions . Builder clear ()
Returns
Overrides
clearConsistencyType()
public ReadOptions . Builder clearConsistencyType ()
Returns
clearField(Descriptors.FieldDescriptor field)
public ReadOptions . Builder clearField ( Descriptors . FieldDescriptor field )
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public ReadOptions . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Parameter
Returns
Overrides
clearReadConsistency()
public ReadOptions . Builder clearReadConsistency ()
The non-transactional read consistency to use.
Cannot be set to STRONG for global queries.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
Returns
clearReadTime()
public ReadOptions . Builder clearReadTime ()
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
clearTransaction()
public ReadOptions . Builder clearTransaction ()
The identifier of the transaction in which to read. A
transaction identifier is returned by a call to
Datastore.BeginTransaction .
bytes transaction = 2;
Returns
clone()
public ReadOptions . Builder clone ()
Returns
Overrides
getConsistencyTypeCase()
public ReadOptions . ConsistencyTypeCase getConsistencyTypeCase ()
Returns
getDefaultInstanceForType()
public ReadOptions getDefaultInstanceForType ()
Returns
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Returns
Overrides
getReadConsistency()
public ReadOptions . ReadConsistency getReadConsistency ()
The non-transactional read consistency to use.
Cannot be set to STRONG for global queries.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
Returns
getReadConsistencyValue()
public int getReadConsistencyValue ()
The non-transactional read consistency to use.
Cannot be set to STRONG for global queries.
.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
getReadTimeBuilder()
public Timestamp . Builder getReadTimeBuilder ()
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
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
hasReadConsistency()
public boolean hasReadConsistency ()
The non-transactional read consistency to use.
Cannot be set to STRONG for global queries.
.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.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Returns
Overrides
isInitialized()
public final boolean isInitialized ()
Returns
Overrides
mergeFrom(ReadOptions other)
public ReadOptions . Builder mergeFrom ( ReadOptions other )
Parameter
Returns
public ReadOptions . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public ReadOptions . Builder mergeFrom ( Message other )
Parameter
Returns
Overrides
mergeReadTime(Timestamp value)
public ReadOptions . Builder mergeReadTime ( Timestamp value )
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;
Parameter
Returns
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ReadOptions . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public ReadOptions . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Parameters
Returns
Overrides
setReadConsistency(ReadOptions.ReadConsistency value)
public ReadOptions . Builder setReadConsistency ( ReadOptions . ReadConsistency value )
The non-transactional read consistency to use.
Cannot be set to STRONG for global queries.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
Parameter
Returns
setReadConsistencyValue(int value)
public ReadOptions . Builder setReadConsistencyValue ( int value )
The non-transactional read consistency to use.
Cannot be set to STRONG for global queries.
.google.datastore.v1.ReadOptions.ReadConsistency read_consistency = 1;
Parameter
Name Description value int The enum numeric value on the wire for readConsistency to set.
Returns
setReadTime(Timestamp value)
public ReadOptions . Builder setReadTime ( Timestamp value )
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;
Parameter
Returns
setReadTime(Timestamp.Builder builderForValue)
public ReadOptions . Builder setReadTime ( Timestamp . Builder builderForValue )
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;
Parameter
Name Description builderForValue Builder
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ReadOptions . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Parameters
Returns
Overrides
setTransaction(ByteString value)
public ReadOptions . Builder setTransaction ( ByteString value )
The identifier of the transaction in which to read. A
transaction identifier is returned by a call to
Datastore.BeginTransaction .
bytes transaction = 2;
Parameter
Name Description value ByteString The transaction to set.
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final ReadOptions . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Parameter
Returns
Overrides
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."],[],[]]
