public final class BeginTransactionRequest extends GeneratedMessage implements BeginTransactionRequestOrBuilderThe request for Firestore.BeginTransaction.
Protobuf type google.firestore.v1.BeginTransactionRequest
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > BeginTransactionRequestImplements
BeginTransactionRequestOrBuilderStatic Fields
DATABASE_FIELD_NUMBER
public static final int DATABASE_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
OPTIONS_FIELD_NUMBER
public static final int OPTIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static BeginTransactionRequest getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static BeginTransactionRequest.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest.Builder |
|
newBuilder(BeginTransactionRequest prototype)
public static BeginTransactionRequest.Builder newBuilder(BeginTransactionRequest prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
BeginTransactionRequest |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest.Builder |
|
parseDelimitedFrom(InputStream input)
public static BeginTransactionRequest parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BeginTransactionRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static BeginTransactionRequest parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static BeginTransactionRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static BeginTransactionRequest parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static BeginTransactionRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static BeginTransactionRequest parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static BeginTransactionRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static BeginTransactionRequest parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static BeginTransactionRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static BeginTransactionRequest parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static BeginTransactionRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<BeginTransactionRequest> parser()| Returns | |
|---|---|
| Type | Description |
Parser<BeginTransactionRequest> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
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 | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
ByteString |
The bytes for database. |
getDefaultInstanceForType()
public BeginTransactionRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest |
|
getOptions()
public TransactionOptions getOptions()The options for the transaction. Defaults to a read-write transaction.
.google.firestore.v1.TransactionOptions options = 2;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
TransactionOptionsOrBuilder |
|
getParserForType()
public Parser<BeginTransactionRequest> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<BeginTransactionRequest> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hasOptions()
public boolean hasOptions()The options for the transaction. Defaults to a read-write transaction.
.google.firestore.v1.TransactionOptions options = 2;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the options field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public BeginTransactionRequest.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected BeginTransactionRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest.Builder |
|
toBuilder()
public BeginTransactionRequest.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
BeginTransactionRequest.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|