Interface DocumentTransform.FieldTransformOrBuilder (3.4.2)

Version 3.4.2

• 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 interface DocumentTransform.FieldTransformOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAppendMissingElements()

public abstract 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.

getAppendMissingElementsOrBuilder()

public abstract 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

getFieldPath()

public abstract 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 abstract 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 abstract 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.

getIncrementOrBuilder()

public abstract 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 abstract 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.

getMaximumOrBuilder()

public abstract 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 abstract 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.

getMinimumOrBuilder()

public abstract 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 abstract 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.

getRemoveAllFromArrayOrBuilder()

public abstract 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 abstract 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 abstract 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 abstract DocumentTransform.FieldTransform.TransformTypeCase getTransformTypeCase()

Returns

Type	Description
DocumentTransform.FieldTransform.TransformTypeCase

hasAppendMissingElements()

public abstract 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 abstract 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 abstract 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 abstract 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 abstract 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 abstract 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.