Class TransactionOptions.ReadOnly.Builder (3.21.1)

public static final class TransactionOptions.ReadOnly.Builder extends GeneratedMessageV3.Builder<TransactionOptions.ReadOnly.Builder> implements TransactionOptions.ReadOnlyOrBuilder

Options for a transaction that can only be used to read documents.

Protobuf type google.firestore.v1.TransactionOptions.ReadOnly

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransactionOptions.ReadOnly.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

build()

public TransactionOptions.ReadOnly build()
Returns
Type Description
TransactionOptions.ReadOnly

buildPartial()

public TransactionOptions.ReadOnly buildPartial()
Returns
Type Description
TransactionOptions.ReadOnly

clear()

public TransactionOptions.ReadOnly.Builder clear()
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

clearConsistencySelector()

public TransactionOptions.ReadOnly.Builder clearConsistencySelector()
Returns
Type Description
TransactionOptions.ReadOnly.Builder

clearField(Descriptors.FieldDescriptor field)

public TransactionOptions.ReadOnly.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public TransactionOptions.ReadOnly.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

clearReadTime()

public TransactionOptions.ReadOnly.Builder clearReadTime()

Reads documents at the given time.

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 = 2;

Returns
Type Description
TransactionOptions.ReadOnly.Builder

clone()

public TransactionOptions.ReadOnly.Builder clone()
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

getConsistencySelectorCase()

public TransactionOptions.ReadOnly.ConsistencySelectorCase getConsistencySelectorCase()
Returns
Type Description
TransactionOptions.ReadOnly.ConsistencySelectorCase

getDefaultInstanceForType()

public TransactionOptions.ReadOnly getDefaultInstanceForType()
Returns
Type Description
TransactionOptions.ReadOnly

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getReadTime()

public Timestamp getReadTime()

Reads documents at the given time.

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 = 2;

Returns
Type Description
Timestamp

The readTime.

getReadTimeBuilder()

public Timestamp.Builder getReadTimeBuilder()

Reads documents at the given time.

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 = 2;

Returns
Type Description
Builder

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Reads documents at the given time.

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 = 2;

Returns
Type Description
TimestampOrBuilder

hasReadTime()

public boolean hasReadTime()

Reads documents at the given time.

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 = 2;

Returns
Type Description
boolean

Whether the readTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(TransactionOptions.ReadOnly other)

public TransactionOptions.ReadOnly.Builder mergeFrom(TransactionOptions.ReadOnly other)
Parameter
Name Description
other TransactionOptions.ReadOnly
Returns
Type Description
TransactionOptions.ReadOnly.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransactionOptions.ReadOnly.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public TransactionOptions.ReadOnly.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

mergeReadTime(Timestamp value)

public TransactionOptions.ReadOnly.Builder mergeReadTime(Timestamp value)

Reads documents at the given time.

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 = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
TransactionOptions.ReadOnly.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransactionOptions.ReadOnly.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public TransactionOptions.ReadOnly.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

setReadTime(Timestamp value)

public TransactionOptions.ReadOnly.Builder setReadTime(Timestamp value)

Reads documents at the given time.

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 = 2;

Parameter
Name Description
value Timestamp
Returns
Type Description
TransactionOptions.ReadOnly.Builder

setReadTime(Timestamp.Builder builderForValue)

public TransactionOptions.ReadOnly.Builder setReadTime(Timestamp.Builder builderForValue)

Reads documents at the given time.

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 = 2;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
TransactionOptions.ReadOnly.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public TransactionOptions.ReadOnly.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TransactionOptions.ReadOnly.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides