public static final class BatchWriteRequest.Builder extends GeneratedMessageV3.Builder<BatchWriteRequest.Builder> implements BatchWriteRequestOrBuilder
The request for
Firestore.BatchWrite.
Protobuf type google.firestore.v1.BatchWriteRequest
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 BatchWriteRequest.Builder addAllWrites(Iterable<? extends Write> values)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
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 BatchWriteRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
addWrites(Write value)
public BatchWriteRequest.Builder addWrites(Write value)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
value | Write
|
addWrites(Write.Builder builderForValue)
public BatchWriteRequest.Builder addWrites(Write.Builder builderForValue)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
addWrites(int index, Write value)
public BatchWriteRequest.Builder addWrites(int index, Write value)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Parameters |
|---|
| Name | Description |
index | int
|
value | Write
|
addWrites(int index, Write.Builder builderForValue)
public BatchWriteRequest.Builder addWrites(int index, Write.Builder builderForValue)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
addWritesBuilder()
public Write.Builder addWritesBuilder()
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
addWritesBuilder(int index)
public Write.Builder addWritesBuilder(int index)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
build()
public BatchWriteRequest build()
buildPartial()
public BatchWriteRequest buildPartial()
clear()
public BatchWriteRequest.Builder clear()
Overrides
clearDatabase()
public BatchWriteRequest.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 BatchWriteRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearLabels()
public BatchWriteRequest.Builder clearLabels()
clearOneof(Descriptors.OneofDescriptor oneof)
public BatchWriteRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearWrites()
public BatchWriteRequest.Builder clearWrites()
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
clone()
public BatchWriteRequest.Builder clone()
Overrides
containsLabels(String key)
public boolean containsLabels(String key)
Labels associated with this batch write.
map<string, string> labels = 3;
| Parameter |
|---|
| Name | Description |
key | String
|
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 BatchWriteRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getLabels()
public Map<String,String> getLabels()
getLabelsCount()
public int getLabelsCount()
Labels associated with this batch write.
map<string, string> labels = 3;
| Returns |
|---|
| Type | Description |
int | |
getLabelsMap()
public Map<String,String> getLabelsMap()
Labels associated with this batch write.
map<string, string> labels = 3;
getLabelsOrDefault(String key, String defaultValue)
public String getLabelsOrDefault(String key, String defaultValue)
Labels associated with this batch write.
map<string, string> labels = 3;
getLabelsOrThrow(String key)
public String getLabelsOrThrow(String key)
Labels associated with this batch write.
map<string, string> labels = 3;
| Parameter |
|---|
| Name | Description |
key | String
|
getMutableLabels()
public Map<String,String> getMutableLabels()
Use alternate mutation accessors instead.
getWrites(int index)
public Write getWrites(int index)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
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.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getWritesBuilderList()
public List<Write.Builder> getWritesBuilderList()
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
getWritesCount()
public int getWritesCount()
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Returns |
|---|
| Type | Description |
int | |
getWritesList()
public List<Write> getWritesList()
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
getWritesOrBuilder(int index)
public WriteOrBuilder getWritesOrBuilder(int index)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
getWritesOrBuilderList()
public List<? extends WriteOrBuilder> getWritesOrBuilderList()
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Returns |
|---|
| Type | Description |
List<? extends com.google.firestore.v1.WriteOrBuilder> | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
internalGetMapField(int number)
protected MapField internalGetMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
internalGetMutableMapField(int number)
protected MapField internalGetMutableMapField(int number)
| Parameter |
|---|
| Name | Description |
number | int
|
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(BatchWriteRequest other)
public BatchWriteRequest.Builder mergeFrom(BatchWriteRequest other)
public BatchWriteRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public BatchWriteRequest.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final BatchWriteRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
putAllLabels(Map<String,String> values)
public BatchWriteRequest.Builder putAllLabels(Map<String,String> values)
Labels associated with this batch write.
map<string, string> labels = 3;
putLabels(String key, String value)
public BatchWriteRequest.Builder putLabels(String key, String value)
Labels associated with this batch write.
map<string, string> labels = 3;
removeLabels(String key)
public BatchWriteRequest.Builder removeLabels(String key)
Labels associated with this batch write.
map<string, string> labels = 3;
| Parameter |
|---|
| Name | Description |
key | String
|
removeWrites(int index)
public BatchWriteRequest.Builder removeWrites(int index)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Parameter |
|---|
| Name | Description |
index | int
|
setDatabase(String value)
public BatchWriteRequest.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 BatchWriteRequest.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 BatchWriteRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public BatchWriteRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final BatchWriteRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
setWrites(int index, Write value)
public BatchWriteRequest.Builder setWrites(int index, Write value)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
| Parameters |
|---|
| Name | Description |
index | int
|
value | Write
|
setWrites(int index, Write.Builder builderForValue)
public BatchWriteRequest.Builder setWrites(int index, Write.Builder builderForValue)
The writes to apply.
Method does not apply writes atomically and does not guarantee ordering.
Each write succeeds or fails independently. You cannot write to the same
document more than once per request.
repeated .google.firestore.v1.Write writes = 2;
