Class TransactionOptions.ReadOnly (3.21.4)

public static final class TransactionOptions.ReadOnly extends GeneratedMessageV3 implements TransactionOptions.ReadOnlyOrBuilder

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

Protobuf type google.firestore.v1.TransactionOptions.ReadOnly

Static Fields

READ_TIME_FIELD_NUMBER

public static final int READ_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransactionOptions.ReadOnly getDefaultInstance()
Returns
Type Description
TransactionOptions.ReadOnly

getDescriptor()

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

newBuilder()

public static TransactionOptions.ReadOnly.Builder newBuilder()
Returns
Type Description
TransactionOptions.ReadOnly.Builder

newBuilder(TransactionOptions.ReadOnly prototype)

public static TransactionOptions.ReadOnly.Builder newBuilder(TransactionOptions.ReadOnly prototype)
Parameter
Name Description
prototype TransactionOptions.ReadOnly
Returns
Type Description
TransactionOptions.ReadOnly.Builder

parseDelimitedFrom(InputStream input)

public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static TransactionOptions.ReadOnly parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransactionOptions.ReadOnly parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransactionOptions.ReadOnly parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static TransactionOptions.ReadOnly parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
TransactionOptions.ReadOnly
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<TransactionOptions.ReadOnly> parser()
Returns
Type Description
Parser<ReadOnly>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getConsistencySelectorCase()

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

getDefaultInstanceForType()

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

getParserForType()

public Parser<TransactionOptions.ReadOnly> getParserForType()
Returns
Type Description
Parser<ReadOnly>
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.

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransactionOptions.ReadOnly.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransactionOptions.ReadOnly.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException