Class WriteResult.Builder (3.22.0)

Version 3.22.0

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

public static final class WriteResult.Builder extends GeneratedMessageV3.Builder<WriteResult.Builder> implements WriteResultOrBuilder

The result of applying a write.

Protobuf type google.firestore.v1.WriteResult

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > WriteResult.Builder

Implements

WriteResultOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllTransformResults(Iterable<? extends Value> values)

public WriteResult.Builder addAllTransformResults(Iterable<? extends Value> values)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name	Description
values	Iterable<? extends com.google.firestore.v1.Value>

Returns
Type	Description
WriteResult.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public WriteResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

addTransformResults(Value value)

public WriteResult.Builder addTransformResults(Value value)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name	Description
value	Value

Returns
Type	Description
WriteResult.Builder

addTransformResults(Value.Builder builderForValue)

public WriteResult.Builder addTransformResults(Value.Builder builderForValue)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name	Description
builderForValue	Value.Builder

Returns
Type	Description
WriteResult.Builder

addTransformResults(int index, Value value)

public WriteResult.Builder addTransformResults(int index, Value value)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
WriteResult.Builder

addTransformResults(int index, Value.Builder builderForValue)

public WriteResult.Builder addTransformResults(int index, Value.Builder builderForValue)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameters
Name	Description
index	int
builderForValue	Value.Builder

Returns
Type	Description
WriteResult.Builder

addTransformResultsBuilder()

public Value.Builder addTransformResultsBuilder()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Returns
Type	Description
Value.Builder

addTransformResultsBuilder(int index)

public Value.Builder addTransformResultsBuilder(int index)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Value.Builder

build()

public WriteResult build()

Returns
Type	Description
WriteResult

buildPartial()

public WriteResult buildPartial()

Returns
Type	Description
WriteResult

clear()

public WriteResult.Builder clear()

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public WriteResult.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearTransformResults()

public WriteResult.Builder clearTransformResults()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Returns
Type	Description
WriteResult.Builder

clearUpdateTime()

public WriteResult.Builder clearUpdateTime()

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Returns
Type	Description
WriteResult.Builder

clone()

public WriteResult.Builder clone()

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public WriteResult getDefaultInstanceForType()

Returns
Type	Description
WriteResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getTransformResults(int index)

public Value getTransformResults(int index)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Value

getTransformResultsBuilder(int index)

public Value.Builder getTransformResultsBuilder(int index)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
Value.Builder

getTransformResultsBuilderList()

public List<Value.Builder> getTransformResultsBuilderList()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Returns
Type	Description
List<Builder>

getTransformResultsCount()

public int getTransformResultsCount()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Returns
Type	Description
int

getTransformResultsList()

public List<Value> getTransformResultsList()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Returns
Type	Description
List<Value>

getTransformResultsOrBuilder(int index)

public ValueOrBuilder getTransformResultsOrBuilder(int index)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
ValueOrBuilder

getTransformResultsOrBuilderList()

public List<? extends ValueOrBuilder> getTransformResultsOrBuilderList()

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Returns
Type	Description
List<? extends com.google.firestore.v1.ValueOrBuilder>

getUpdateTime()

public Timestamp getUpdateTime()

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Returns
Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Returns
Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Returns
Type	Description
TimestampOrBuilder

hasUpdateTime()

public boolean hasUpdateTime()

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Returns
Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(WriteResult other)

public WriteResult.Builder mergeFrom(WriteResult other)

Parameter
Name	Description
other	WriteResult

Returns
Type	Description
WriteResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public WriteResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
WriteResult.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public WriteResult.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
WriteResult.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public WriteResult.Builder mergeUpdateTime(Timestamp value)

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
WriteResult.Builder

removeTransformResults(int index)

public WriteResult.Builder removeTransformResults(int index)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameter
Name	Description
index	int

Returns
Type	Description
WriteResult.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public WriteResult.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public WriteResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTransformResults(int index, Value value)

public WriteResult.Builder setTransformResults(int index, Value value)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameters
Name	Description
index	int
value	Value

Returns
Type	Description
WriteResult.Builder

setTransformResults(int index, Value.Builder builderForValue)

public WriteResult.Builder setTransformResults(int index, Value.Builder builderForValue)

The results of applying each DocumentTransform.FieldTransform, in the same order.

repeated .google.firestore.v1.Value transform_results = 2;

Parameters
Name	Description
index	int
builderForValue	Value.Builder

Returns
Type	Description
WriteResult.Builder

setUnknownFields(UnknownFieldSet unknownFields)

public final WriteResult.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
WriteResult.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public WriteResult.Builder setUpdateTime(Timestamp value)

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Parameter
Name	Description
value	Timestamp

Returns
Type	Description
WriteResult.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public WriteResult.Builder setUpdateTime(Timestamp.Builder builderForValue)

The last update time of the document after applying the write. Not set after a delete.

If the write did not actually change the document, this will be the previous update_time.

.google.protobuf.Timestamp update_time = 1;

Parameter
Name	Description
builderForValue	Builder

Returns
Type	Description
WriteResult.Builder