Class DocumentTransform.FieldTransform (3.14.4)

public static final class DocumentTransform.FieldTransform extends GeneratedMessageV3 implements DocumentTransform.FieldTransformOrBuilder

A transformation of a field of the document.

Protobuf type google.firestore.v1.DocumentTransform.FieldTransform

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentTransform.FieldTransform

Static Fields

APPEND_MISSING_ELEMENTS_FIELD_NUMBER

public static final int APPEND_MISSING_ELEMENTS_FIELD_NUMBER
Field Value
TypeDescription
int

FIELD_PATH_FIELD_NUMBER

public static final int FIELD_PATH_FIELD_NUMBER
Field Value
TypeDescription
int

INCREMENT_FIELD_NUMBER

public static final int INCREMENT_FIELD_NUMBER
Field Value
TypeDescription
int

MAXIMUM_FIELD_NUMBER

public static final int MAXIMUM_FIELD_NUMBER
Field Value
TypeDescription
int

MINIMUM_FIELD_NUMBER

public static final int MINIMUM_FIELD_NUMBER
Field Value
TypeDescription
int

REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER

public static final int REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER
Field Value
TypeDescription
int

SET_TO_SERVER_VALUE_FIELD_NUMBER

public static final int SET_TO_SERVER_VALUE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static DocumentTransform.FieldTransform getDefaultInstance()
Returns
TypeDescription
DocumentTransform.FieldTransform

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static DocumentTransform.FieldTransform.Builder newBuilder()
Returns
TypeDescription
DocumentTransform.FieldTransform.Builder

newBuilder(DocumentTransform.FieldTransform prototype)

public static DocumentTransform.FieldTransform.Builder newBuilder(DocumentTransform.FieldTransform prototype)
Parameter
NameDescription
prototypeDocumentTransform.FieldTransform
Returns
TypeDescription
DocumentTransform.FieldTransform.Builder

parseDelimitedFrom(InputStream input)

public static DocumentTransform.FieldTransform parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentTransform.FieldTransform parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static DocumentTransform.FieldTransform parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentTransform.FieldTransform parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentTransform.FieldTransform parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentTransform.FieldTransform parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentTransform.FieldTransform parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentTransform.FieldTransform parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static DocumentTransform.FieldTransform parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentTransform.FieldTransform parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static DocumentTransform.FieldTransform parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentTransform.FieldTransform parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
DocumentTransform.FieldTransform
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<DocumentTransform.FieldTransform> parser()
Returns
TypeDescription
Parser<FieldTransform>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
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
TypeDescription
ArrayValue

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;

Returns
TypeDescription
ArrayValueOrBuilder

getDefaultInstanceForType()

public DocumentTransform.FieldTransform getDefaultInstanceForType()
Returns
TypeDescription
DocumentTransform.FieldTransform

getFieldPath()

public String getFieldPath()

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

string field_path = 1;

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
Value

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;

Returns
TypeDescription
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
TypeDescription
Value

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;

Returns
TypeDescription
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
TypeDescription
Value

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;

Returns
TypeDescription
ValueOrBuilder

getParserForType()

public Parser<DocumentTransform.FieldTransform> getParserForType()
Returns
TypeDescription
Parser<FieldTransform>
Overrides

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
TypeDescription
ArrayValue

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;

Returns
TypeDescription
ArrayValueOrBuilder

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

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
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for setToServerValue.

getTransformTypeCase()

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

Whether the setToServerValue field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public DocumentTransform.FieldTransform.Builder newBuilderForType()
Returns
TypeDescription
DocumentTransform.FieldTransform.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentTransform.FieldTransform.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
DocumentTransform.FieldTransform.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public DocumentTransform.FieldTransform.Builder toBuilder()
Returns
TypeDescription
DocumentTransform.FieldTransform.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException