Class DocumentTransform.FieldTransform.Builder (3.22.0)

public static final class DocumentTransform.FieldTransform.Builder extends GeneratedMessageV3.Builder<DocumentTransform.FieldTransform.Builder> implements DocumentTransform.FieldTransformOrBuilder

A transformation of a field of the document.

Protobuf type google.firestore.v1.DocumentTransform.FieldTransform

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentTransform.FieldTransform.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentTransform.FieldTransform.Builder
Overrides

build()

public DocumentTransform.FieldTransform build()
Returns
Type Description
DocumentTransform.FieldTransform

buildPartial()

public DocumentTransform.FieldTransform buildPartial()
Returns
Type Description
DocumentTransform.FieldTransform

clear()

public DocumentTransform.FieldTransform.Builder clear()
Returns
Type Description
DocumentTransform.FieldTransform.Builder
Overrides

clearAppendMissingElements()

public DocumentTransform.FieldTransform.Builder clearAppendMissingElements()

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue append_missing_elements = 6;

Returns
Type Description
DocumentTransform.FieldTransform.Builder

clearField(Descriptors.FieldDescriptor field)

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

clearFieldPath()

public DocumentTransform.FieldTransform.Builder clearFieldPath()

The path of the field. See Document.fields for the field path syntax reference.

string field_path = 1;

Returns
Type Description
DocumentTransform.FieldTransform.Builder

This builder for chaining.

clearIncrement()

public DocumentTransform.FieldTransform.Builder clearIncrement()

Adds the given value to the field's current value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

.google.firestore.v1.Value increment = 3;

Returns
Type Description
DocumentTransform.FieldTransform.Builder

clearMaximum()

public DocumentTransform.FieldTransform.Builder clearMaximum()

Sets the field to the maximum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value maximum = 4;

Returns
Type Description
DocumentTransform.FieldTransform.Builder

clearMinimum()

public DocumentTransform.FieldTransform.Builder clearMinimum()

Sets the field to the minimum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value minimum = 5;

Returns
Type Description
DocumentTransform.FieldTransform.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

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

clearRemoveAllFromArray()

public DocumentTransform.FieldTransform.Builder clearRemoveAllFromArray()

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue remove_all_from_array = 7;

Returns
Type Description
DocumentTransform.FieldTransform.Builder

clearSetToServerValue()

public DocumentTransform.FieldTransform.Builder clearSetToServerValue()

Sets the field to the given server value.

.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;

Returns
Type Description
DocumentTransform.FieldTransform.Builder

This builder for chaining.

clearTransformType()

public DocumentTransform.FieldTransform.Builder clearTransformType()
Returns
Type Description
DocumentTransform.FieldTransform.Builder

clone()

public DocumentTransform.FieldTransform.Builder clone()
Returns
Type Description
DocumentTransform.FieldTransform.Builder
Overrides

getAppendMissingElements()

public ArrayValue getAppendMissingElements()

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue append_missing_elements = 6;

Returns
Type Description
ArrayValue

The appendMissingElements.

getAppendMissingElementsBuilder()

public ArrayValue.Builder getAppendMissingElementsBuilder()

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue append_missing_elements = 6;

Returns
Type Description
ArrayValue.Builder

getAppendMissingElementsOrBuilder()

public ArrayValueOrBuilder getAppendMissingElementsOrBuilder()

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue append_missing_elements = 6;

Returns
Type Description
ArrayValueOrBuilder

getDefaultInstanceForType()

public DocumentTransform.FieldTransform getDefaultInstanceForType()
Returns
Type Description
DocumentTransform.FieldTransform

getDescriptorForType()

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

getFieldPath()

public String getFieldPath()

The path of the field. See Document.fields for the field path syntax reference.

string field_path = 1;

Returns
Type Description
String

The fieldPath.

getFieldPathBytes()

public ByteString getFieldPathBytes()

The path of the field. See Document.fields for the field path syntax reference.

string field_path = 1;

Returns
Type Description
ByteString

The bytes for fieldPath.

getIncrement()

public Value getIncrement()

Adds the given value to the field's current value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

.google.firestore.v1.Value increment = 3;

Returns
Type Description
Value

The increment.

getIncrementBuilder()

public Value.Builder getIncrementBuilder()

Adds the given value to the field's current value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

.google.firestore.v1.Value increment = 3;

Returns
Type Description
Value.Builder

getIncrementOrBuilder()

public ValueOrBuilder getIncrementOrBuilder()

Adds the given value to the field's current value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

.google.firestore.v1.Value increment = 3;

Returns
Type Description
ValueOrBuilder

getMaximum()

public Value getMaximum()

Sets the field to the maximum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value maximum = 4;

Returns
Type Description
Value

The maximum.

getMaximumBuilder()

public Value.Builder getMaximumBuilder()

Sets the field to the maximum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value maximum = 4;

Returns
Type Description
Value.Builder

getMaximumOrBuilder()

public ValueOrBuilder getMaximumOrBuilder()

Sets the field to the maximum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value maximum = 4;

Returns
Type Description
ValueOrBuilder

getMinimum()

public Value getMinimum()

Sets the field to the minimum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value minimum = 5;

Returns
Type Description
Value

The minimum.

getMinimumBuilder()

public Value.Builder getMinimumBuilder()

Sets the field to the minimum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value minimum = 5;

Returns
Type Description
Value.Builder

getMinimumOrBuilder()

public ValueOrBuilder getMinimumOrBuilder()

Sets the field to the minimum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value minimum = 5;

Returns
Type Description
ValueOrBuilder

getRemoveAllFromArray()

public ArrayValue getRemoveAllFromArray()

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue remove_all_from_array = 7;

Returns
Type Description
ArrayValue

The removeAllFromArray.

getRemoveAllFromArrayBuilder()

public ArrayValue.Builder getRemoveAllFromArrayBuilder()

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue remove_all_from_array = 7;

Returns
Type Description
ArrayValue.Builder

getRemoveAllFromArrayOrBuilder()

public ArrayValueOrBuilder getRemoveAllFromArrayOrBuilder()

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue remove_all_from_array = 7;

Returns
Type Description
ArrayValueOrBuilder

getSetToServerValue()

public DocumentTransform.FieldTransform.ServerValue getSetToServerValue()

Sets the field to the given server value.

.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;

Returns
Type Description
DocumentTransform.FieldTransform.ServerValue

The setToServerValue.

getSetToServerValueValue()

public int getSetToServerValueValue()

Sets the field to the given server value.

.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;

Returns
Type Description
int

The enum numeric value on the wire for setToServerValue.

getTransformTypeCase()

public DocumentTransform.FieldTransform.TransformTypeCase getTransformTypeCase()
Returns
Type Description
DocumentTransform.FieldTransform.TransformTypeCase

hasAppendMissingElements()

public boolean hasAppendMissingElements()

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue append_missing_elements = 6;

Returns
Type Description
boolean

Whether the appendMissingElements field is set.

hasIncrement()

public boolean hasIncrement()

Adds the given value to the field's current value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

.google.firestore.v1.Value increment = 3;

Returns
Type Description
boolean

Whether the increment field is set.

hasMaximum()

public boolean hasMaximum()

Sets the field to the maximum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value maximum = 4;

Returns
Type Description
boolean

Whether the maximum field is set.

hasMinimum()

public boolean hasMinimum()

Sets the field to the minimum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value minimum = 5;

Returns
Type Description
boolean

Whether the minimum field is set.

hasRemoveAllFromArray()

public boolean hasRemoveAllFromArray()

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue remove_all_from_array = 7;

Returns
Type Description
boolean

Whether the removeAllFromArray field is set.

hasSetToServerValue()

public boolean hasSetToServerValue()

Sets the field to the given server value.

.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;

Returns
Type Description
boolean

Whether the setToServerValue field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeAppendMissingElements(ArrayValue value)

public DocumentTransform.FieldTransform.Builder mergeAppendMissingElements(ArrayValue value)

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue append_missing_elements = 6;

Parameter
Name Description
value ArrayValue
Returns
Type Description
DocumentTransform.FieldTransform.Builder

mergeFrom(DocumentTransform.FieldTransform other)

public DocumentTransform.FieldTransform.Builder mergeFrom(DocumentTransform.FieldTransform other)
Parameter
Name Description
other DocumentTransform.FieldTransform
Returns
Type Description
DocumentTransform.FieldTransform.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentTransform.FieldTransform.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentTransform.FieldTransform.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

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

mergeIncrement(Value value)

public DocumentTransform.FieldTransform.Builder mergeIncrement(Value value)

Adds the given value to the field's current value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

.google.firestore.v1.Value increment = 3;

Parameter
Name Description
value Value
Returns
Type Description
DocumentTransform.FieldTransform.Builder

mergeMaximum(Value value)

public DocumentTransform.FieldTransform.Builder mergeMaximum(Value value)

Sets the field to the maximum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value maximum = 4;

Parameter
Name Description
value Value
Returns
Type Description
DocumentTransform.FieldTransform.Builder

mergeMinimum(Value value)

public DocumentTransform.FieldTransform.Builder mergeMinimum(Value value)

Sets the field to the minimum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value minimum = 5;

Parameter
Name Description
value Value
Returns
Type Description
DocumentTransform.FieldTransform.Builder

mergeRemoveAllFromArray(ArrayValue value)

public DocumentTransform.FieldTransform.Builder mergeRemoveAllFromArray(ArrayValue value)

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue remove_all_from_array = 7;

Parameter
Name Description
value ArrayValue
Returns
Type Description
DocumentTransform.FieldTransform.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setAppendMissingElements(ArrayValue value)

public DocumentTransform.FieldTransform.Builder setAppendMissingElements(ArrayValue value)

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue append_missing_elements = 6;

Parameter
Name Description
value ArrayValue
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setAppendMissingElements(ArrayValue.Builder builderForValue)

public DocumentTransform.FieldTransform.Builder setAppendMissingElements(ArrayValue.Builder builderForValue)

Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array.

Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue append_missing_elements = 6;

Parameter
Name Description
builderForValue ArrayValue.Builder
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentTransform.FieldTransform.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentTransform.FieldTransform.Builder
Overrides

setFieldPath(String value)

public DocumentTransform.FieldTransform.Builder setFieldPath(String value)

The path of the field. See Document.fields for the field path syntax reference.

string field_path = 1;

Parameter
Name Description
value String

The fieldPath to set.

Returns
Type Description
DocumentTransform.FieldTransform.Builder

This builder for chaining.

setFieldPathBytes(ByteString value)

public DocumentTransform.FieldTransform.Builder setFieldPathBytes(ByteString value)

The path of the field. See Document.fields for the field path syntax reference.

string field_path = 1;

Parameter
Name Description
value ByteString

The bytes for fieldPath to set.

Returns
Type Description
DocumentTransform.FieldTransform.Builder

This builder for chaining.

setIncrement(Value value)

public DocumentTransform.FieldTransform.Builder setIncrement(Value value)

Adds the given value to the field's current value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

.google.firestore.v1.Value increment = 3;

Parameter
Name Description
value Value
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setIncrement(Value.Builder builderForValue)

public DocumentTransform.FieldTransform.Builder setIncrement(Value.Builder builderForValue)

Adds the given value to the field's current value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.

.google.firestore.v1.Value increment = 3;

Parameter
Name Description
builderForValue Value.Builder
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setMaximum(Value value)

public DocumentTransform.FieldTransform.Builder setMaximum(Value value)

Sets the field to the maximum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value maximum = 4;

Parameter
Name Description
value Value
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setMaximum(Value.Builder builderForValue)

public DocumentTransform.FieldTransform.Builder setMaximum(Value.Builder builderForValue)

Sets the field to the maximum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value maximum = 4;

Parameter
Name Description
builderForValue Value.Builder
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setMinimum(Value value)

public DocumentTransform.FieldTransform.Builder setMinimum(Value value)

Sets the field to the minimum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value minimum = 5;

Parameter
Name Description
value Value
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setMinimum(Value.Builder builderForValue)

public DocumentTransform.FieldTransform.Builder setMinimum(Value.Builder builderForValue)

Sets the field to the minimum of its current value and the given value.

This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.

.google.firestore.v1.Value minimum = 5;

Parameter
Name Description
builderForValue Value.Builder
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setRemoveAllFromArray(ArrayValue value)

public DocumentTransform.FieldTransform.Builder setRemoveAllFromArray(ArrayValue value)

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue remove_all_from_array = 7;

Parameter
Name Description
value ArrayValue
Returns
Type Description
DocumentTransform.FieldTransform.Builder

setRemoveAllFromArray(ArrayValue.Builder builderForValue)

public DocumentTransform.FieldTransform.Builder setRemoveAllFromArray(ArrayValue.Builder builderForValue)

Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array.

Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates.

The corresponding transform_result will be the null value.

.google.firestore.v1.ArrayValue remove_all_from_array = 7;

Parameter
Name Description
builderForValue ArrayValue.Builder
Returns
Type Description
DocumentTransform.FieldTransform.Builder

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

public DocumentTransform.FieldTransform.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DocumentTransform.FieldTransform.Builder
Overrides

setSetToServerValue(DocumentTransform.FieldTransform.ServerValue value)

public DocumentTransform.FieldTransform.Builder setSetToServerValue(DocumentTransform.FieldTransform.ServerValue value)

Sets the field to the given server value.

.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;

Parameter
Name Description
value DocumentTransform.FieldTransform.ServerValue

The setToServerValue to set.

Returns
Type Description
DocumentTransform.FieldTransform.Builder

This builder for chaining.

setSetToServerValueValue(int value)

public DocumentTransform.FieldTransform.Builder setSetToServerValueValue(int value)

Sets the field to the given server value.

.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;

Parameter
Name Description
value int

The enum numeric value on the wire for setToServerValue to set.

Returns
Type Description
DocumentTransform.FieldTransform.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentTransform.FieldTransform.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentTransform.FieldTransform.Builder
Overrides