Class TransactionOptions.ReadOnly.Builder (3.16.3)

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
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public TransactionOptions.ReadOnly.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides

build()

public TransactionOptions.ReadOnly build()
Returns
TypeDescription
TransactionOptions.ReadOnly

buildPartial()

public TransactionOptions.ReadOnly buildPartial()
Returns
TypeDescription
TransactionOptions.ReadOnly

clear()

public TransactionOptions.ReadOnly.Builder clear()
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides

clearConsistencySelector()

public TransactionOptions.ReadOnly.Builder clearConsistencySelector()
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

clearField(Descriptors.FieldDescriptor field)

public TransactionOptions.ReadOnly.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public TransactionOptions.ReadOnly.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
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
TypeDescription
TransactionOptions.ReadOnly.Builder

clone()

public TransactionOptions.ReadOnly.Builder clone()
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides

getConsistencySelectorCase()

public TransactionOptions.ReadOnly.ConsistencySelectorCase getConsistencySelectorCase()
Returns
TypeDescription
TransactionOptions.ReadOnly.ConsistencySelectorCase

getDefaultInstanceForType()

public TransactionOptions.ReadOnly getDefaultInstanceForType()
Returns
TypeDescription
TransactionOptions.ReadOnly

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
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
TypeDescription
boolean

Whether the readTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(TransactionOptions.ReadOnly other)

public TransactionOptions.ReadOnly.Builder mergeFrom(TransactionOptions.ReadOnly other)
Parameter
NameDescription
otherTransactionOptions.ReadOnly
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public TransactionOptions.ReadOnly.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public TransactionOptions.ReadOnly.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final TransactionOptions.ReadOnly.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public TransactionOptions.ReadOnly.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
valueTimestamp
Returns
TypeDescription
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
NameDescription
builderForValueBuilder
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

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

public TransactionOptions.ReadOnly.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final TransactionOptions.ReadOnly.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides