public static final class CommitRequest.Builder extends GeneratedMessageV3.Builder<CommitRequest.Builder> implements CommitRequestOrBuilder
The request for Firestore.Commit.
Protobuf type google.firestore.v1.CommitRequest
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
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;
| Name | Description |
| values | Iterable<? extends com.google.firestore.v1.Write>
|
Returns
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CommitRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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;
| Name | Description |
| value | Write
|
Returns
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;
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;
build()
public CommitRequest build()
Returns
buildPartial()
public CommitRequest buildPartial()
Returns
clear()
public CommitRequest.Builder clear()
Returns
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)
Parameter
Returns
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public CommitRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Returns
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()
Returns
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];
| 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];
getDefaultInstanceForType()
public CommitRequest getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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;
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;
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;
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;
getWritesOrBuilderList()
public List<? extends WriteOrBuilder> getWritesOrBuilderList()
The writes to apply.
Always executed atomically and in order.
repeated .google.firestore.v1.Write writes = 2;
| Type | Description |
| List<? extends com.google.firestore.v1.WriteOrBuilder> | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(CommitRequest other)
public CommitRequest.Builder mergeFrom(CommitRequest other)
Parameter
Returns
public CommitRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public CommitRequest.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CommitRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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;
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];
| Name | Description |
| value | String
The database to set.
|
Returns
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];
| Name | Description |
| value | ByteString
The bytes for database to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public CommitRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CommitRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setTransaction(ByteString value)
public CommitRequest.Builder setTransaction(ByteString value)
If set, applies all writes in this transaction, and commits it.
bytes transaction = 3;
| Name | Description |
| value | ByteString
The transaction to set.
|
Returns
setUnknownFields(UnknownFieldSet unknownFields)
public final CommitRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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;
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;
