Package com.google.firestore.v1

Interface DocumentTransform.FieldTransformOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DocumentTransform.FieldTransform, DocumentTransform.FieldTransform.Builder
Enclosing class:
DocumentTransform
public static interface DocumentTransform.FieldTransformOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • getFieldPath

      String getFieldPath()
       The path of the field. See
 [Document.fields][google.firestore.v1.Document.fields] for the field path
 syntax reference.
      string field_path = 1;
      Returns:
      The fieldPath.

    • getFieldPathBytes

      com.google.protobuf.ByteString getFieldPathBytes()
       The path of the field. See
 [Document.fields][google.firestore.v1.Document.fields] for the field path
 syntax reference.
      string field_path = 1;
      Returns:
      The bytes for fieldPath.

    • hasSetToServerValue

      boolean hasSetToServerValue()
       Sets the field to the given server value.
      .google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
      Returns:
      Whether the setToServerValue field is set.

    • getSetToServerValueValue

      int getSetToServerValueValue()
       Sets the field to the given server value.
      .google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
      Returns:
      The enum numeric value on the wire for setToServerValue.

    • getSetToServerValue

      DocumentTransform.FieldTransform.ServerValue getSetToServerValue()
       Sets the field to the given server value.
      .google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
      Returns:
      The setToServerValue.

    • hasIncrement

      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:
      Whether the increment field is set.

    • getIncrement

      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:
      The increment.

    • getIncrementOrBuilder

      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;

    • hasMaximum

      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:
      Whether the maximum field is set.

    • getMaximum

      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:
      The maximum.

    • getMaximumOrBuilder

      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;

    • hasMinimum

      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:
      Whether the minimum field is set.

    • getMinimum

      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:
      The minimum.

    • getMinimumOrBuilder

      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;

    • hasAppendMissingElements

      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:
      Whether the appendMissingElements field is set.

    • getAppendMissingElements

      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:
      The appendMissingElements.

    • getAppendMissingElementsOrBuilder

      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;

    • hasRemoveAllFromArray

      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:
      Whether the removeAllFromArray field is set.

    • getRemoveAllFromArray

      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:
      The removeAllFromArray.

    • getRemoveAllFromArrayOrBuilder

      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;

    • getTransformTypeCase

      DocumentTransform.FieldTransform.TransformTypeCase getTransformTypeCase()