Class TransactionOptions (3.21.0)

public final class TransactionOptions extends GeneratedMessageV3 implements TransactionOptionsOrBuilder

Options for creating a new transaction.

Protobuf type google.firestore.v1.TransactionOptions

Static Fields

READ_ONLY_FIELD_NUMBER

public static final int READ_ONLY_FIELD_NUMBER
Field Value
Type Description
int

READ_WRITE_FIELD_NUMBER

public static final int READ_WRITE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static TransactionOptions getDefaultInstance()
Returns
Type Description
TransactionOptions

getDescriptor()

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

newBuilder()

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

newBuilder(TransactionOptions prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public TransactionOptions getDefaultInstanceForType()
Returns
Type Description
TransactionOptions

getModeCase()

public TransactionOptions.ModeCase getModeCase()
Returns
Type Description
TransactionOptions.ModeCase

getParserForType()

public Parser<TransactionOptions> getParserForType()
Returns
Type Description
Parser<TransactionOptions>
Overrides

getReadOnly()

public TransactionOptions.ReadOnly getReadOnly()

The transaction can only be used for read operations.

.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;

Returns
Type Description
TransactionOptions.ReadOnly

The readOnly.

getReadOnlyOrBuilder()

public TransactionOptions.ReadOnlyOrBuilder getReadOnlyOrBuilder()

The transaction can only be used for read operations.

.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;

Returns
Type Description
TransactionOptions.ReadOnlyOrBuilder

getReadWrite()

public TransactionOptions.ReadWrite getReadWrite()

The transaction can be used for both read and write operations.

.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;

Returns
Type Description
TransactionOptions.ReadWrite

The readWrite.

getReadWriteOrBuilder()

public TransactionOptions.ReadWriteOrBuilder getReadWriteOrBuilder()

The transaction can be used for both read and write operations.

.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;

Returns
Type Description
TransactionOptions.ReadWriteOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hasReadOnly()

public boolean hasReadOnly()

The transaction can only be used for read operations.

.google.firestore.v1.TransactionOptions.ReadOnly read_only = 2;

Returns
Type Description
boolean

Whether the readOnly field is set.

hasReadWrite()

public boolean hasReadWrite()

The transaction can be used for both read and write operations.

.google.firestore.v1.TransactionOptions.ReadWrite read_write = 3;

Returns
Type Description
boolean

Whether the readWrite 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.Builder newBuilderForType()
Returns
Type Description
TransactionOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected TransactionOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
TransactionOptions.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.Builder toBuilder()
Returns
Type Description
TransactionOptions.Builder

writeTo(CodedOutputStream output)

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