Package com.google.firestore.v1

Class DocumentTransform.FieldTransform

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.firestore.v1.DocumentTransform.FieldTransform
All Implemented Interfaces:
DocumentTransform.FieldTransformOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
DocumentTransform
public static final class DocumentTransform.FieldTransform extends com.google.protobuf.GeneratedMessageV3 implements DocumentTransform.FieldTransformOrBuilder
 A transformation of a field of the document.
Protobuf type google.firestore.v1.DocumentTransform.FieldTransform
See Also:

  • Field Details

    • FIELD_PATH_FIELD_NUMBER

      public static final int FIELD_PATH_FIELD_NUMBER
      See Also:

    • SET_TO_SERVER_VALUE_FIELD_NUMBER

      public static final int SET_TO_SERVER_VALUE_FIELD_NUMBER
      See Also:

    • INCREMENT_FIELD_NUMBER

      public static final int INCREMENT_FIELD_NUMBER
      See Also:

    • MAXIMUM_FIELD_NUMBER

      public static final int MAXIMUM_FIELD_NUMBER
      See Also:

    • MINIMUM_FIELD_NUMBER

      public static final int MINIMUM_FIELD_NUMBER
      See Also:

    • APPEND_MISSING_ELEMENTS_FIELD_NUMBER

      public static final int APPEND_MISSING_ELEMENTS_FIELD_NUMBER
      See Also:

    • REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER

      public static final int REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getTransformTypeCase

      public DocumentTransform.FieldTransform.TransformTypeCase getTransformTypeCase()
      Specified by:
      getTransformTypeCase in interface DocumentTransform.FieldTransformOrBuilder

    • getFieldPath

      public 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;
      Specified by:
      getFieldPath in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      The fieldPath.

    • getFieldPathBytes

      public 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;
      Specified by:
      getFieldPathBytes in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      The bytes for fieldPath.

    • hasSetToServerValue

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

    • getSetToServerValueValue

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

    • 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;
      Specified by:
      getSetToServerValue in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      The setToServerValue.

    • 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;
      Specified by:
      hasIncrement in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      Whether the increment field is set.

    • 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;
      Specified by:
      getIncrement in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      The increment.

    • 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;
      Specified by:
      getIncrementOrBuilder in interface DocumentTransform.FieldTransformOrBuilder

    • 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;
      Specified by:
      hasMaximum in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      Whether the maximum field is set.

    • 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;
      Specified by:
      getMaximum in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      The maximum.

    • 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;
      Specified by:
      getMaximumOrBuilder in interface DocumentTransform.FieldTransformOrBuilder

    • 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;
      Specified by:
      hasMinimum in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      Whether the minimum field is set.

    • 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;
      Specified by:
      getMinimum in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      The minimum.

    • 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;
      Specified by:
      getMinimumOrBuilder in interface DocumentTransform.FieldTransformOrBuilder

    • 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;
      Specified by:
      hasAppendMissingElements in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      Whether the appendMissingElements field is set.

    • 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;
      Specified by:
      getAppendMissingElements in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      The appendMissingElements.

    • 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;
      Specified by:
      getAppendMissingElementsOrBuilder in interface DocumentTransform.FieldTransformOrBuilder

    • 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;
      Specified by:
      hasRemoveAllFromArray in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      Whether the removeAllFromArray field is set.

    • 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;
      Specified by:
      getRemoveAllFromArray in interface DocumentTransform.FieldTransformOrBuilder
      Returns:
      The removeAllFromArray.

    • 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;
      Specified by:
      getRemoveAllFromArrayOrBuilder in interface DocumentTransform.FieldTransformOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DocumentTransform.FieldTransform parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DocumentTransform.FieldTransform parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DocumentTransform.FieldTransform parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DocumentTransform.FieldTransform.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DocumentTransform.FieldTransform.Builder newBuilder()

    • newBuilder

      public static DocumentTransform.FieldTransform.Builder newBuilder(DocumentTransform.FieldTransform prototype)

    • toBuilder

      public DocumentTransform.FieldTransform.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DocumentTransform.FieldTransform.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static DocumentTransform.FieldTransform getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DocumentTransform.FieldTransform> parser()

    • getParserForType

      public com.google.protobuf.Parser<DocumentTransform.FieldTransform> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public DocumentTransform.FieldTransform getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder