com.google.firestore.v1

Class BatchWriteRequest.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

com.google.firestore.v1.BatchWriteRequest.Builder

All Implemented Interfaces:

BatchWriteRequestOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

BatchWriteRequest

public static final class BatchWriteRequest.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>
implements BatchWriteRequestOrBuilder

 The request for
 [Firestore.BatchWrite][google.firestore.v1.Firestore.BatchWrite].
 

Protobuf type google.firestore.v1.BatchWriteRequest

Method Summary

Modifier and Type	Method and Description
BatchWriteRequest.Builder	addAllWrites(Iterable<? extends Write> values) The writes to apply.
BatchWriteRequest.Builder	addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BatchWriteRequest.Builder	addWrites(int index, Write.Builder builderForValue) The writes to apply.
BatchWriteRequest.Builder	addWrites(int index, Write value) The writes to apply.
BatchWriteRequest.Builder	addWrites(Write.Builder builderForValue) The writes to apply.
BatchWriteRequest.Builder	addWrites(Write value) The writes to apply.
Write.Builder	addWritesBuilder() The writes to apply.
Write.Builder	addWritesBuilder(int index) The writes to apply.
BatchWriteRequest	build()
BatchWriteRequest	buildPartial()
BatchWriteRequest.Builder	clear()
BatchWriteRequest.Builder	clearDatabase() Required.
BatchWriteRequest.Builder	clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
BatchWriteRequest.Builder	clearLabels()
BatchWriteRequest.Builder	clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
BatchWriteRequest.Builder	clearWrites() The writes to apply.
BatchWriteRequest.Builder	clone()
boolean	containsLabels(String key) Labels associated with this batch write.
String	getDatabase() Required.
com.google.protobuf.ByteString	getDatabaseBytes() Required.
BatchWriteRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Labels associated with this batch write.
Map<String,String>	getLabelsMap() Labels associated with this batch write.
String	getLabelsOrDefault(String key, String defaultValue) Labels associated with this batch write.
String	getLabelsOrThrow(String key) Labels associated with this batch write.
Map<String,String>	getMutableLabels() Deprecated.
Write	getWrites(int index) The writes to apply.
Write.Builder	getWritesBuilder(int index) The writes to apply.
List<Write.Builder>	getWritesBuilderList() The writes to apply.
int	getWritesCount() The writes to apply.
List<Write>	getWritesList() The writes to apply.
WriteOrBuilder	getWritesOrBuilder(int index) The writes to apply.
List<? extends WriteOrBuilder>	getWritesOrBuilderList() The writes to apply.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
protected com.google.protobuf.MapField	internalGetMapField(int number)
protected com.google.protobuf.MapField	internalGetMutableMapField(int number)
boolean	isInitialized()
BatchWriteRequest.Builder	mergeFrom(BatchWriteRequest other)
BatchWriteRequest.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
BatchWriteRequest.Builder	mergeFrom(com.google.protobuf.Message other)
BatchWriteRequest.Builder	mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
BatchWriteRequest.Builder	putAllLabels(Map<String,String> values) Labels associated with this batch write.
BatchWriteRequest.Builder	putLabels(String key, String value) Labels associated with this batch write.
BatchWriteRequest.Builder	removeLabels(String key) Labels associated with this batch write.
BatchWriteRequest.Builder	removeWrites(int index) The writes to apply.
BatchWriteRequest.Builder	setDatabase(String value) Required.
BatchWriteRequest.Builder	setDatabaseBytes(com.google.protobuf.ByteString value) Required.
BatchWriteRequest.Builder	setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
BatchWriteRequest.Builder	setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
BatchWriteRequest.Builder	setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
BatchWriteRequest.Builder	setWrites(int index, Write.Builder builderForValue) The writes to apply.
BatchWriteRequest.Builder	setWrites(int index, Write value) The writes to apply.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapField

protected com.google.protobuf.MapField internalGetMapField(int number)

Overrides:

internalGetMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

internalGetMutableMapField

protected com.google.protobuf.MapField internalGetMutableMapField(int number)

Overrides:

internalGetMutableMapField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

clear

public BatchWriteRequest.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

getDefaultInstanceForType

public BatchWriteRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public BatchWriteRequest build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public BatchWriteRequest buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone

public BatchWriteRequest.Builder clone()

Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

setField

public BatchWriteRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                          Object value)

Specified by:

setField in interface com.google.protobuf.Message.Builder

Overrides:

setField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

clearField

public BatchWriteRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)

Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

clearOneof

public BatchWriteRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

setRepeatedField

public BatchWriteRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  int index,
                                                  Object value)

Specified by:

setRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

addRepeatedField

public BatchWriteRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                  Object value)

Specified by:

addRepeatedField in interface com.google.protobuf.Message.Builder

Overrides:

addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

mergeFrom

public BatchWriteRequest.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchWriteRequest.Builder>

mergeFrom

public BatchWriteRequest.Builder mergeFrom(BatchWriteRequest other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

mergeFrom

public BatchWriteRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<BatchWriteRequest.Builder>

Throws:

IOException

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];

Specified by:

getDatabase in interface BatchWriteRequestOrBuilder

Returns:

The database.

getDatabaseBytes

public com.google.protobuf.ByteString getDatabaseBytes()

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

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

Specified by:

getDatabaseBytes in interface BatchWriteRequestOrBuilder

Returns:

The bytes for database.

setDatabase

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];

Parameters:

value - The database to set.

Returns:

This builder for chaining.

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];

Returns:

This builder for chaining.

setDatabaseBytes

public BatchWriteRequest.Builder setDatabaseBytes(com.google.protobuf.ByteString value)

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

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

Parameters:

value - The bytes for database to set.

Returns:

This builder for chaining.

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;

Specified by:

getWritesList in interface BatchWriteRequestOrBuilder

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;

Specified by:

getWritesCount in interface BatchWriteRequestOrBuilder

getWrites

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;

Specified by:

getWrites in interface BatchWriteRequestOrBuilder

setWrites

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;

setWrites

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;

addWrites

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;

addWrites

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;

addWrites

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

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;

addAllWrites

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;

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;

removeWrites

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;

getWritesBuilder

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;

getWritesOrBuilder

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;

Specified by:

getWritesOrBuilder in interface BatchWriteRequestOrBuilder

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;

Specified by:

getWritesOrBuilderList in interface BatchWriteRequestOrBuilder

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

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;

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;

getLabelsCount

public int getLabelsCount()

Description copied from interface: BatchWriteRequestOrBuilder

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

getLabelsCount in interface BatchWriteRequestOrBuilder

containsLabels

public boolean containsLabels(String key)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

containsLabels in interface BatchWriteRequestOrBuilder

getLabels

@Deprecated
public Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

Specified by:

getLabels in interface BatchWriteRequestOrBuilder

getLabelsMap

public Map<String,String> getLabelsMap()

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

getLabelsMap in interface BatchWriteRequestOrBuilder

getLabelsOrDefault

public String getLabelsOrDefault(String key,
                                 String defaultValue)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

getLabelsOrDefault in interface BatchWriteRequestOrBuilder

getLabelsOrThrow

public String getLabelsOrThrow(String key)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

Specified by:

getLabelsOrThrow in interface BatchWriteRequestOrBuilder

clearLabels

public BatchWriteRequest.Builder clearLabels()

removeLabels

public BatchWriteRequest.Builder removeLabels(String key)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

getMutableLabels

@Deprecated
public Map<String,String> getMutableLabels()

Deprecated.

Use alternate mutation accessors instead.

putLabels

public BatchWriteRequest.Builder putLabels(String key,
                                           String value)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

putAllLabels

public BatchWriteRequest.Builder putAllLabels(Map<String,String> values)

 Labels associated with this batch write.
 

map<string, string> labels = 3;

setUnknownFields

public final BatchWriteRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>

mergeUnknownFields

public final BatchWriteRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface com.google.protobuf.Message.Builder

Overrides:

mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<BatchWriteRequest.Builder>