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
Modifier and Type | Class and Description |
---|---|
static class |
DocumentTransform.FieldTransform.Builder
A transformation of a field of the document.
|
static class |
DocumentTransform.FieldTransform.ServerValue
A value that is calculated by the server.
|
static class |
DocumentTransform.FieldTransform.TransformTypeCase |
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
Modifier and Type | Field and Description |
---|---|
static int |
APPEND_MISSING_ELEMENTS_FIELD_NUMBER |
static int |
FIELD_PATH_FIELD_NUMBER |
static int |
INCREMENT_FIELD_NUMBER |
static int |
MAXIMUM_FIELD_NUMBER |
static int |
MINIMUM_FIELD_NUMBER |
static int |
REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER |
static int |
SET_TO_SERVER_VALUE_FIELD_NUMBER |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj) |
ArrayValue |
getAppendMissingElements()
Append the given elements in order if they are not already present in
the current field value.
|
ArrayValueOrBuilder |
getAppendMissingElementsOrBuilder()
Append the given elements in order if they are not already present in
the current field value.
|
static DocumentTransform.FieldTransform |
getDefaultInstance() |
DocumentTransform.FieldTransform |
getDefaultInstanceForType() |
static com.google.protobuf.Descriptors.Descriptor |
getDescriptor() |
String |
getFieldPath()
The path of the field.
|
com.google.protobuf.ByteString |
getFieldPathBytes()
The path of the field.
|
Value |
getIncrement()
Adds the given value to the field's current value.
|
ValueOrBuilder |
getIncrementOrBuilder()
Adds the given value to the field's current value.
|
Value |
getMaximum()
Sets the field to the maximum of its current value and the given value.
|
ValueOrBuilder |
getMaximumOrBuilder()
Sets the field to the maximum of its current value and the given value.
|
Value |
getMinimum()
Sets the field to the minimum of its current value and the given value.
|
ValueOrBuilder |
getMinimumOrBuilder()
Sets the field to the minimum of its current value and the given value.
|
com.google.protobuf.Parser<DocumentTransform.FieldTransform> |
getParserForType() |
ArrayValue |
getRemoveAllFromArray()
Remove all of the given elements from the array in the field.
|
ArrayValueOrBuilder |
getRemoveAllFromArrayOrBuilder()
Remove all of the given elements from the array in the field.
|
int |
getSerializedSize() |
DocumentTransform.FieldTransform.ServerValue |
getSetToServerValue()
Sets the field to the given server value.
|
int |
getSetToServerValueValue()
Sets the field to the given server value.
|
DocumentTransform.FieldTransform.TransformTypeCase |
getTransformTypeCase() |
com.google.protobuf.UnknownFieldSet |
getUnknownFields() |
boolean |
hasAppendMissingElements()
Append the given elements in order if they are not already present in
the current field value.
|
int |
hashCode() |
boolean |
hasIncrement()
Adds the given value to the field's current value.
|
boolean |
hasMaximum()
Sets the field to the maximum of its current value and the given value.
|
boolean |
hasMinimum()
Sets the field to the minimum of its current value and the given value.
|
boolean |
hasRemoveAllFromArray()
Remove all of the given elements from the array in the field.
|
boolean |
hasSetToServerValue()
Sets the field to the given server value.
|
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable |
internalGetFieldAccessorTable() |
boolean |
isInitialized() |
static DocumentTransform.FieldTransform.Builder |
newBuilder() |
static DocumentTransform.FieldTransform.Builder |
newBuilder(DocumentTransform.FieldTransform prototype) |
DocumentTransform.FieldTransform.Builder |
newBuilderForType() |
protected DocumentTransform.FieldTransform.Builder |
newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) |
protected Object |
newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) |
static DocumentTransform.FieldTransform |
parseDelimitedFrom(InputStream input) |
static DocumentTransform.FieldTransform |
parseDelimitedFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentTransform.FieldTransform |
parseFrom(byte[] data) |
static DocumentTransform.FieldTransform |
parseFrom(byte[] data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentTransform.FieldTransform |
parseFrom(ByteBuffer data) |
static DocumentTransform.FieldTransform |
parseFrom(ByteBuffer data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentTransform.FieldTransform |
parseFrom(com.google.protobuf.ByteString data) |
static DocumentTransform.FieldTransform |
parseFrom(com.google.protobuf.ByteString data,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentTransform.FieldTransform |
parseFrom(com.google.protobuf.CodedInputStream input) |
static DocumentTransform.FieldTransform |
parseFrom(com.google.protobuf.CodedInputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static DocumentTransform.FieldTransform |
parseFrom(InputStream input) |
static DocumentTransform.FieldTransform |
parseFrom(InputStream input,
com.google.protobuf.ExtensionRegistryLite extensionRegistry) |
static com.google.protobuf.Parser<DocumentTransform.FieldTransform> |
parser() |
DocumentTransform.FieldTransform.Builder |
toBuilder() |
void |
writeTo(com.google.protobuf.CodedOutputStream output) |
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
public static final int FIELD_PATH_FIELD_NUMBER
public static final int SET_TO_SERVER_VALUE_FIELD_NUMBER
public static final int INCREMENT_FIELD_NUMBER
public static final int MAXIMUM_FIELD_NUMBER
public static final int MINIMUM_FIELD_NUMBER
public static final int APPEND_MISSING_ELEMENTS_FIELD_NUMBER
public static final int REMOVE_ALL_FROM_ARRAY_FIELD_NUMBER
protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
newInstance
in class com.google.protobuf.GeneratedMessageV3
public final com.google.protobuf.UnknownFieldSet getUnknownFields()
getUnknownFields
in interface com.google.protobuf.MessageOrBuilder
getUnknownFields
in class com.google.protobuf.GeneratedMessageV3
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
internalGetFieldAccessorTable
in class com.google.protobuf.GeneratedMessageV3
public DocumentTransform.FieldTransform.TransformTypeCase getTransformTypeCase()
getTransformTypeCase
in interface DocumentTransform.FieldTransformOrBuilder
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;
getFieldPath
in interface DocumentTransform.FieldTransformOrBuilder
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;
getFieldPathBytes
in interface DocumentTransform.FieldTransformOrBuilder
public boolean hasSetToServerValue()
Sets the field to the given server value.
.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
hasSetToServerValue
in interface DocumentTransform.FieldTransformOrBuilder
public int getSetToServerValueValue()
Sets the field to the given server value.
.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
getSetToServerValueValue
in interface DocumentTransform.FieldTransformOrBuilder
public DocumentTransform.FieldTransform.ServerValue getSetToServerValue()
Sets the field to the given server value.
.google.firestore.v1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;
getSetToServerValue
in interface DocumentTransform.FieldTransformOrBuilder
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;
hasIncrement
in interface DocumentTransform.FieldTransformOrBuilder
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;
getIncrement
in interface DocumentTransform.FieldTransformOrBuilder
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;
getIncrementOrBuilder
in interface DocumentTransform.FieldTransformOrBuilder
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;
hasMaximum
in interface DocumentTransform.FieldTransformOrBuilder
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;
getMaximum
in interface DocumentTransform.FieldTransformOrBuilder
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;
getMaximumOrBuilder
in interface DocumentTransform.FieldTransformOrBuilder
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;
hasMinimum
in interface DocumentTransform.FieldTransformOrBuilder
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;
getMinimum
in interface DocumentTransform.FieldTransformOrBuilder
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;
getMinimumOrBuilder
in interface DocumentTransform.FieldTransformOrBuilder
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;
hasAppendMissingElements
in interface DocumentTransform.FieldTransformOrBuilder
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;
getAppendMissingElements
in interface DocumentTransform.FieldTransformOrBuilder
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;
getAppendMissingElementsOrBuilder
in interface DocumentTransform.FieldTransformOrBuilder
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;
hasRemoveAllFromArray
in interface DocumentTransform.FieldTransformOrBuilder
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;
getRemoveAllFromArray
in interface DocumentTransform.FieldTransformOrBuilder
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;
getRemoveAllFromArrayOrBuilder
in interface DocumentTransform.FieldTransformOrBuilder
public final boolean isInitialized()
isInitialized
in interface com.google.protobuf.MessageLiteOrBuilder
isInitialized
in class com.google.protobuf.GeneratedMessageV3
public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
writeTo
in interface com.google.protobuf.MessageLite
writeTo
in class com.google.protobuf.GeneratedMessageV3
IOException
public int getSerializedSize()
getSerializedSize
in interface com.google.protobuf.MessageLite
getSerializedSize
in class com.google.protobuf.GeneratedMessageV3
public boolean equals(Object obj)
equals
in interface com.google.protobuf.Message
equals
in class com.google.protobuf.AbstractMessage
public int hashCode()
hashCode
in interface com.google.protobuf.Message
hashCode
in class com.google.protobuf.AbstractMessage
public static DocumentTransform.FieldTransform parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static DocumentTransform.FieldTransform parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static DocumentTransform.FieldTransform parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static DocumentTransform.FieldTransform parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static DocumentTransform.FieldTransform parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static DocumentTransform.FieldTransform parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
com.google.protobuf.InvalidProtocolBufferException
public static DocumentTransform.FieldTransform parseFrom(InputStream input) throws IOException
IOException
public static DocumentTransform.FieldTransform parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DocumentTransform.FieldTransform parseDelimitedFrom(InputStream input) throws IOException
IOException
public static DocumentTransform.FieldTransform parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public static DocumentTransform.FieldTransform parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
IOException
public static DocumentTransform.FieldTransform parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
IOException
public DocumentTransform.FieldTransform.Builder newBuilderForType()
newBuilderForType
in interface com.google.protobuf.Message
newBuilderForType
in interface com.google.protobuf.MessageLite
public static DocumentTransform.FieldTransform.Builder newBuilder()
public static DocumentTransform.FieldTransform.Builder newBuilder(DocumentTransform.FieldTransform prototype)
public DocumentTransform.FieldTransform.Builder toBuilder()
toBuilder
in interface com.google.protobuf.Message
toBuilder
in interface com.google.protobuf.MessageLite
protected DocumentTransform.FieldTransform.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
newBuilderForType
in class com.google.protobuf.GeneratedMessageV3
public static DocumentTransform.FieldTransform getDefaultInstance()
public static com.google.protobuf.Parser<DocumentTransform.FieldTransform> parser()
public com.google.protobuf.Parser<DocumentTransform.FieldTransform> getParserForType()
getParserForType
in interface com.google.protobuf.Message
getParserForType
in interface com.google.protobuf.MessageLite
getParserForType
in class com.google.protobuf.GeneratedMessageV3
public DocumentTransform.FieldTransform getDefaultInstanceForType()
getDefaultInstanceForType
in interface com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType
in interface com.google.protobuf.MessageOrBuilder
Copyright © 2023 Google LLC. All rights reserved.