public static final class CommitRequest.Builder extends GeneratedMessageV3.Builder<CommitRequest.Builder> implements CommitRequestOrBuilder
The request for Firestore.Commit.
Protobuf type google.firestore.v1.CommitRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addAllWrites(Iterable<? extends Write> values)
public CommitRequest.Builder addAllWrites(Iterable<? extends Write> values)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
values | Iterable<? extends com.google.firestore.v1.Write>
|
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CommitRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
addWrites(Write value)
public CommitRequest.Builder addWrites(Write value)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
value | Write
|
addWrites(Write.Builder builderForValue)
public CommitRequest.Builder addWrites(Write.Builder builderForValue)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
addWrites(int index, Write value)
public CommitRequest.Builder addWrites(int index, Write value)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameters |
|---|
| Name | Description |
index | int
|
value | Write
|
addWrites(int index, Write.Builder builderForValue)
public CommitRequest.Builder addWrites(int index, Write.Builder builderForValue)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
addWritesBuilder()
public Write.Builder addWritesBuilder()
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
addWritesBuilder(int index)
public Write.Builder addWritesBuilder(int index)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
build()
public CommitRequest build()
buildPartial()
public CommitRequest buildPartial()
clear()
public CommitRequest.Builder clear()
Overrides
clearDatabase()
public CommitRequest.Builder clearDatabase()
Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
clearField(Descriptors.FieldDescriptor field)
public CommitRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public CommitRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearTransaction()
public CommitRequest.Builder clearTransaction()
If set, applies all writes in this transaction, and commits it.
bytes transaction = 3;
clearWrites()
public CommitRequest.Builder clearWrites()
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
clone()
public CommitRequest.Builder clone()
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 |
|---|
| 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 CommitRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getTransaction()
public ByteString getTransaction()
If set, applies all writes in this transaction, and commits it.
bytes transaction = 3;
getWrites(int index)
public Write getWrites(int index)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
| Returns |
|---|
| Type | Description |
Write | |
getWritesBuilder(int index)
public Write.Builder getWritesBuilder(int index)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getWritesBuilderList()
public List<Write.Builder> getWritesBuilderList()
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
getWritesCount()
public int getWritesCount()
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Returns |
|---|
| Type | Description |
int | |
getWritesList()
public List<Write> getWritesList()
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
getWritesOrBuilder(int index)
public WriteOrBuilder getWritesOrBuilder(int index)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getWritesOrBuilderList()
public List<? extends WriteOrBuilder> getWritesOrBuilderList()
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Returns |
|---|
| Type | Description |
List<? extends com.google.firestore.v1.WriteOrBuilder> | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(CommitRequest other)
public CommitRequest.Builder mergeFrom(CommitRequest other)
public CommitRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public CommitRequest.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CommitRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
removeWrites(int index)
public CommitRequest.Builder removeWrites(int index)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
setDatabase(String value)
public CommitRequest.Builder setDatabase(String value)
Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
|---|
| Name | Description |
value | String
The database to set.
|
setDatabaseBytes(ByteString value)
public CommitRequest.Builder setDatabaseBytes(ByteString value)
Required. The database name. In the format:
projects/{project_id}/databases/{database_id}.
string database = 1 [(.google.api.field_behavior) = REQUIRED];
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for database to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public CommitRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CommitRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setTransaction(ByteString value)
public CommitRequest.Builder setTransaction(ByteString value)
If set, applies all writes in this transaction, and commits it.
bytes transaction = 3;
| Parameter |
|---|
| Name | Description |
value | ByteString
The transaction to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CommitRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
setWrites(int index, Write value)
public CommitRequest.Builder setWrites(int index, Write value)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Parameters |
|---|
| Name | Description |
index | int
|
value | Write
|
setWrites(int index, Write.Builder builderForValue)
public CommitRequest.Builder setWrites(int index, Write.Builder builderForValue)
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
