Class BeginTransactionRequest (3.3.0)

public final class BeginTransactionRequest extends GeneratedMessageV3 implements BeginTransactionRequestOrBuilder

The request for Firestore.BeginTransaction.

Protobuf type google.firestore.v1.BeginTransactionRequest

Static Fields

DATABASE_FIELD_NUMBER

public static final int DATABASE_FIELD_NUMBER
Field Value
TypeDescription
int

OPTIONS_FIELD_NUMBER

public static final int OPTIONS_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static BeginTransactionRequest getDefaultInstance()
Returns
TypeDescription
BeginTransactionRequest

getDescriptor()

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

newBuilder()

public static BeginTransactionRequest.Builder newBuilder()
Returns
TypeDescription
BeginTransactionRequest.Builder

newBuilder(BeginTransactionRequest prototype)

public static BeginTransactionRequest.Builder newBuilder(BeginTransactionRequest prototype)
Parameter
NameDescription
prototypeBeginTransactionRequest
Returns
TypeDescription
BeginTransactionRequest.Builder

parseDelimitedFrom(InputStream input)

public static BeginTransactionRequest parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BeginTransactionRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

public static BeginTransactionRequest parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
BeginTransactionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

public static BeginTransactionRequest parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
BeginTransactionRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

public static BeginTransactionRequest parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
BeginTransactionRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

public static BeginTransactionRequest parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
BeginTransactionRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

public static Parser<BeginTransactionRequest> parser()
Returns
TypeDescription
Parser<BeginTransactionRequest>

Methods

equals(Object obj)

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

getDatabase()

public String getDatabase()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The database.

getDatabaseBytes()

public ByteString getDatabaseBytes()

Required. The database name. In the format: projects/{project_id}/databases/{database_id}.

string database = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for database.

getDefaultInstanceForType()

public BeginTransactionRequest getDefaultInstanceForType()
Returns
TypeDescription
BeginTransactionRequest

getOptions()

public TransactionOptions getOptions()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns
TypeDescription
TransactionOptions

The options.

getOptionsOrBuilder()

public TransactionOptionsOrBuilder getOptionsOrBuilder()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns
TypeDescription
TransactionOptionsOrBuilder

getParserForType()

public Parser<BeginTransactionRequest> getParserForType()
Returns
TypeDescription
Parser<BeginTransactionRequest>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hasOptions()

public boolean hasOptions()

The options for the transaction. Defaults to a read-write transaction.

.google.firestore.v1.TransactionOptions options = 2;

Returns
TypeDescription
boolean

Whether the options 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 BeginTransactionRequest.Builder newBuilderForType()
Returns
TypeDescription
BeginTransactionRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public BeginTransactionRequest.Builder toBuilder()
Returns
TypeDescription
BeginTransactionRequest.Builder

writeTo(CodedOutputStream output)

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