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
Static Fields
public static final int APPEND_MISSING_ELEMENTS_FIELD_NUMBER
Field Value
public static final int FIELD_PATH_FIELD_NUMBER
Field Value
public static final int INCREMENT_FIELD_NUMBER
Field Value
public static final int MAXIMUM_FIELD_NUMBER
Field Value
public static final int MINIMUM_FIELD_NUMBER
Field Value
public static final int REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER
Field Value
public static final int SET_TO_SERVER_VALUE_FIELD_NUMBER
Field Value
Static Methods
public static DocumentTransform.FieldTransform getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static DocumentTransform.FieldTransform.Builder newBuilder()
Returns
public static DocumentTransform.FieldTransform.Builder newBuilder(DocumentTransform.FieldTransform prototype)
Parameter
Returns
public static DocumentTransform.FieldTransform parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentTransform.FieldTransform parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(byte[] data)
Parameter
| Name | Description |
data | byte[]
|
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static DocumentTransform.FieldTransform parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<DocumentTransform.FieldTransform> parser()
Returns
Methods
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
| Type | Description |
ArrayValue | The appendMissingElements.
|
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;
public DocumentTransform.FieldTransform getDefaultInstanceForType()
Returns
public String getFieldPath()
The path of the field. See Document.fields for the field path syntax
reference.
string field_path = 1;
| Type | Description |
String | The fieldPath.
|
public ByteString getFieldPathBytes()
The path of the field. See Document.fields for the field path syntax
reference.
string field_path = 1;
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;
| Type | Description |
Value | The increment.
|
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;
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;
| Type | Description |
Value | The maximum.
|
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;
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;
| Type | Description |
Value | The minimum.
|
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;
public Parser<DocumentTransform.FieldTransform> getParserForType()
Returns
Overrides
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;
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;
public int getSerializedSize()
Returns
Overrides
public DocumentTransform.FieldTransform.ServerValue getSetToServerValue()
Sets the field to the given server value.
.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
public int getSetToServerValueValue()
Sets the field to the given server value.
.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
| Type | Description |
int | The enum numeric value on the wire for setToServerValue.
|
public DocumentTransform.FieldTransform.TransformTypeCase getTransformTypeCase()
Returns
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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;
| Type | Description |
boolean | Whether the appendMissingElements field is set.
|
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;
| Type | Description |
boolean | Whether the increment field is set.
|
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;
| Type | Description |
boolean | Whether the maximum field is set.
|
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;
| Type | Description |
boolean | Whether the minimum field is set.
|
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;
| Type | Description |
boolean | Whether the removeAllFromArray field is set.
|
public boolean hasSetToServerValue()
Sets the field to the given server value.
.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
| Type | Description |
boolean | Whether the setToServerValue field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public DocumentTransform.FieldTransform.Builder newBuilderForType()
Returns
protected DocumentTransform.FieldTransform.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public DocumentTransform.FieldTransform.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
