Class TransactionOptions.ReadWrite (3.22.0)

public static final class TransactionOptions.ReadWrite extends GeneratedMessageV3 implements TransactionOptions.ReadWriteOrBuilder

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

Firestore does not allow 3rd party auth requests to create read-write. transactions.

Protobuf type google.firestore.v1.TransactionOptions.ReadWrite

Static Fields

RETRY_TRANSACTION_FIELD_NUMBER

public static final int RETRY_TRANSACTION_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(TransactionOptions.ReadWrite prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getParserForType()

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

getRetryTransaction()

public ByteString getRetryTransaction()

An optional transaction to retry.

bytes retry_transaction = 1;

Returns
Type Description
ByteString

The retryTransaction.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

writeTo(CodedOutputStream output)

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