com.google.firestore.v1

Class TransactionOptions

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.firestore.v1.TransactionOptions

All Implemented Interfaces:

TransactionOptionsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class TransactionOptions
extends com.google.protobuf.GeneratedMessageV3
implements TransactionOptionsOrBuilder

 Options for creating a new transaction.
 

Protobuf type google.firestore.v1.TransactionOptions

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TransactionOptions.Builder Options for creating a new transaction.
static class	TransactionOptions.ModeCase
static class	TransactionOptions.ReadOnly Options for a transaction that can only be used to read documents.
static interface	TransactionOptions.ReadOnlyOrBuilder
static class	TransactionOptions.ReadWrite Options for a transaction that can be used to read and write documents.
static interface	TransactionOptions.ReadWriteOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	READ_ONLY_FIELD_NUMBER
static int	READ_WRITE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static TransactionOptions	getDefaultInstance()
TransactionOptions	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
TransactionOptions.ModeCase	getModeCase()
com.google.protobuf.Parser<TransactionOptions>	getParserForType()
TransactionOptions.ReadOnly	getReadOnly() The transaction can only be used for read operations.
TransactionOptions.ReadOnlyOrBuilder	getReadOnlyOrBuilder() The transaction can only be used for read operations.
TransactionOptions.ReadWrite	getReadWrite() The transaction can be used for both read and write operations.
TransactionOptions.ReadWriteOrBuilder	getReadWriteOrBuilder() The transaction can be used for both read and write operations.
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
boolean	hasReadOnly() The transaction can only be used for read operations.
boolean	hasReadWrite() The transaction can be used for both read and write operations.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static TransactionOptions.Builder	newBuilder()
static TransactionOptions.Builder	newBuilder(TransactionOptions prototype)
TransactionOptions.Builder	newBuilderForType()
protected TransactionOptions.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static TransactionOptions	parseDelimitedFrom(InputStream input)
static TransactionOptions	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions	parseFrom(byte[] data)
static TransactionOptions	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions	parseFrom(ByteBuffer data)
static TransactionOptions	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions	parseFrom(com.google.protobuf.ByteString data)
static TransactionOptions	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions	parseFrom(com.google.protobuf.CodedInputStream input)
static TransactionOptions	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static TransactionOptions	parseFrom(InputStream input)
static TransactionOptions	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<TransactionOptions>	parser()
TransactionOptions.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

READ_ONLY_FIELD_NUMBER

public static final int READ_ONLY_FIELD_NUMBER

See Also:

Constant Field Values

READ_WRITE_FIELD_NUMBER

public static final int READ_WRITE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getModeCase

public TransactionOptions.ModeCase getModeCase()

Specified by:

getModeCase in interface TransactionOptionsOrBuilder

hasReadOnly

public boolean hasReadOnly()

 The transaction can only be used for read operations.
 

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

Specified by:

hasReadOnly in interface TransactionOptionsOrBuilder

Returns:

Whether the readOnly field is set.

getReadOnly

public TransactionOptions.ReadOnly getReadOnly()

 The transaction can only be used for read operations.
 

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

Specified by:

getReadOnly in interface TransactionOptionsOrBuilder

Returns:

The readOnly.

getReadOnlyOrBuilder

public TransactionOptions.ReadOnlyOrBuilder getReadOnlyOrBuilder()

 The transaction can only be used for read operations.
 

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

Specified by:

getReadOnlyOrBuilder in interface TransactionOptionsOrBuilder

hasReadWrite

public boolean hasReadWrite()

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

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

Specified by:

hasReadWrite in interface TransactionOptionsOrBuilder

Returns:

Whether the readWrite field is set.

getReadWrite

public TransactionOptions.ReadWrite getReadWrite()

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

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

Specified by:

getReadWrite in interface TransactionOptionsOrBuilder

Returns:

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;

Specified by:

getReadWriteOrBuilder in interface TransactionOptionsOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static TransactionOptions parseFrom(ByteBuffer data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions parseFrom(ByteBuffer data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions parseFrom(com.google.protobuf.ByteString data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions parseFrom(com.google.protobuf.ByteString data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions parseFrom(byte[] data)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions parseFrom(byte[] data,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static TransactionOptions parseFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static TransactionOptions parseFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static TransactionOptions parseDelimitedFrom(InputStream input)
                                             throws IOException

Throws:

IOException

parseDelimitedFrom

public static TransactionOptions parseDelimitedFrom(InputStream input,
                                                    com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                             throws IOException

Throws:

IOException

parseFrom

public static TransactionOptions parseFrom(com.google.protobuf.CodedInputStream input)
                                    throws IOException

Throws:

IOException

parseFrom

public static TransactionOptions parseFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

newBuilderForType

public TransactionOptions.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static TransactionOptions.Builder newBuilder()

newBuilder

public static TransactionOptions.Builder newBuilder(TransactionOptions prototype)

toBuilder

public TransactionOptions.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected TransactionOptions.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static TransactionOptions getDefaultInstance()

parser

public static com.google.protobuf.Parser<TransactionOptions> parser()

getParserForType

public com.google.protobuf.Parser<TransactionOptions> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public TransactionOptions getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder