com.google.firestore.v1beta1

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 Summary

Modifier and Type	Method and Description
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.
String	getFieldPath() The path of the field.
com.google.protobuf.ByteString	getFieldPathBytes() The path of the field.
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.
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()
boolean	hasAppendMissingElements() Append the given elements in order if they are not already present in the current field value.
boolean	hasRemoveAllFromArray() Remove all of the given elements from the array in the field.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getFieldPath

String getFieldPath()

 The path of the field. See [Document.fields][google.firestore.v1beta1.Document.fields] for the field path syntax
 reference.
 

string field_path = 1;

getFieldPathBytes

com.google.protobuf.ByteString getFieldPathBytes()

 The path of the field. See [Document.fields][google.firestore.v1beta1.Document.fields] for the field path syntax
 reference.
 

string field_path = 1;

getSetToServerValueValue

int getSetToServerValueValue()

 Sets the field to the given server value.
 

.google.firestore.v1beta1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;

getSetToServerValue

DocumentTransform.FieldTransform.ServerValue getSetToServerValue()

 Sets the field to the given server value.
 

.google.firestore.v1beta1.DocumentTransform.FieldTransform.ServerValue set_to_server_value = 2;

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.v1beta1.ArrayValue append_missing_elements = 6;

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.v1beta1.ArrayValue append_missing_elements = 6;

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.v1beta1.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.v1beta1.ArrayValue remove_all_from_array = 7;

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.v1beta1.ArrayValue remove_all_from_array = 7;

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.v1beta1.ArrayValue remove_all_from_array = 7;

getTransformTypeCase

DocumentTransform.FieldTransform.TransformTypeCase getTransformTypeCase()