Class TransactionOptions.ReadWrite (3.14.4)

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

Static Methods

getDefaultInstance()

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

getDescriptor()

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

newBuilder()

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

newBuilder(TransactionOptions.ReadWrite prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

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

getParserForType()

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

getRetryTransaction()

public ByteString getRetryTransaction()

An optional transaction to retry.

bytes retry_transaction = 1;

Returns
TypeDescription
ByteString

The retryTransaction.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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