Class WriteResult.Builder (3.21.0)

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

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

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

clearField(Descriptors.FieldDescriptor field)

public WriteResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
WriteResult.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public WriteResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
WriteResult.Builder
Overrides

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

getDefaultInstanceForType()

public WriteResult getDefaultInstanceForType()
Returns
Type Description
WriteResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

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
Exceptions
Type Description
IOException

mergeFrom(Message other)

public WriteResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
WriteResult.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final WriteResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
WriteResult.Builder
Overrides

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

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

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

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