Class TransactionOptions.ReadOnly (3.2.0)

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

Static Methods

getDefaultInstance()

public static TransactionOptions.ReadOnly getDefaultInstance()
Returns
TypeDescription
TransactionOptions.ReadOnly

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static TransactionOptions.ReadOnly.Builder newBuilder()
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

newBuilder(TransactionOptions.ReadOnly prototype)

public static TransactionOptions.ReadOnly.Builder newBuilder(TransactionOptions.ReadOnly prototype)
Parameter
NameDescription
prototypeTransactionOptions.ReadOnly
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder

parseDelimitedFrom(InputStream input)

public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static TransactionOptions.ReadOnly parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static TransactionOptions.ReadOnly parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static TransactionOptions.ReadOnly parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static TransactionOptions.ReadOnly parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static TransactionOptions.ReadOnly parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
TransactionOptions.ReadOnly
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getConsistencySelectorCase()

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

getDefaultInstanceForType()

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

getParserForType()

public Parser<TransactionOptions.ReadOnly> getParserForType()
Returns
TypeDescription
Parser<ReadOnly>
Overrides

getReadTime()

public Timestamp getReadTime()

Reads documents at the given time. This may not be older than 60 seconds.

.google.protobuf.Timestamp read_time = 2;

Returns
TypeDescription
Timestamp

The readTime.

getReadTimeOrBuilder()

public TimestampOrBuilder getReadTimeOrBuilder()

Reads documents at the given time. This may not be older than 60 seconds.

.google.protobuf.Timestamp read_time = 2;

Returns
TypeDescription
TimestampOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasReadTime()

public boolean hasReadTime()

Reads documents at the given time. This may not be older than 60 seconds.

.google.protobuf.Timestamp read_time = 2;

Returns
TypeDescription
boolean

Whether the readTime field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransactionOptions.ReadOnly.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
TransactionOptions.ReadOnly.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

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

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException