# FieldValue
```
abstract class FieldValue
```
*** ** * ** ***
Sentinel values that can be used when writing document fields with `set()` or `
update()`.
## Summary
| ### Public functions |
|---|---|
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#arrayRemove(java.lang.Object...)(elements: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html!)` Returns a special value that can be used with `set()` or `update()` that tells the server to remove the given elements from any array value that already exists on the server. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#arrayUnion(java.lang.Object...)(elements: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html!)` Returns a special value that can be used with `set()` or `update()` that tells the server to union the given elements with any array value that already exists on the server. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#delete()()` Returns a sentinel for use with `update()` to mark a field for deletion. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#increment(long)(l: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` Returns a special value that can be used with `set()` or `update()` that tells the server to increment the field's current value by the given value. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#increment(double)(l: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)` Returns a special value that can be used with `set()` or `update()` that tells the server to increment the field's current value by the given value. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#maximum(long)(l: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` Returns a special value that can be used with `set()` or `update()` that tells the server to set the field to the maximum of its current value and the given value. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#maximum(double)(l: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)` Returns a special value that can be used with `set()` or `update()` that tells the server to set the field to the maximum of its current value and the given value. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#minimum(long)(l: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-long/index.html)` Returns a special value that can be used with `set()` or `update()` that tells the server to set the field to the minimum of its current value and the given value. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#minimum(double)(l: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double/index.html)` Returns a special value that can be used with `set()` or `update()` that tells the server to set the field to the minimum of its current value and the given value. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#serverTimestamp()()` Returns a sentinel for use with `set()` or `update()` to include a server-generated timestamp in the written data. |
| `java-static https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/VectorValue` | `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue#vector(double[])(values: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html)` Creates a new `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/VectorValue` constructed with a copy of the given array of doubles. |
## Public functions
### arrayRemove
```
java-static fun arrayRemove(elements: Array!): FieldValue
```
Returns a special value that can be used with `set()` or `update()` that tells the server to remove the given elements from any array value that already exists on the server. All instances of each element specified will be removed from the array. If the field being modified is not already an array it will be overwritten with an empty array.
| Parameters |
|---|---|
| `elements: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html!` | The elements to remove from the array. |
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | The `FieldValue` sentinel for use in a call to `set()` or `update()`. |
### arrayUnion
```
java-static fun arrayUnion(elements: Array!): FieldValue
```
Returns a special value that can be used with `set()` or `update()` that tells the server to union the given elements with any array value that already exists on the server. Each specified element that doesn't already exist in the array will be added to the end. If the field being modified is not already an array it will be overwritten with an array containing exactly the specified elements.
| Parameters |
|---|---|
| `elements: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html!` | The elements to union into the array. |
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | The `FieldValue` sentinel for use in a call to `set()` or `update()`. |
### delete
```
java-static fun delete(): FieldValue
```
Returns a sentinel for use with `update()` to mark a field for deletion.
### increment
```
java-static fun increment(l: Long): FieldValue
```
Returns a special value that can be used with `set()` or `update()` that tells the server to increment the field's current value by the given value.
If the current field value is an integer, possible integer overflows are resolved to Long.MAX_VALUE or Long.MIN_VALUE. If the current field value is a double, both values will be interpreted as doubles and the arithmetic will follow IEEE 754 semantics.
If the current 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.
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | The `FieldValue` sentinel for use in a call to `set()` or `update()`. |
### increment
```
java-static fun increment(l: Double): FieldValue
```
Returns a special value that can be used with `set()` or `update()` that tells the server to increment the field's current value by the given value.
If the current value is an integer or a double, both the current and the given value will be interpreted as doubles and all arithmetic will follow IEEE 754 semantics. Otherwise, the transformation will set the field to the given value.
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | The `FieldValue` sentinel for use in a call to `set()` or `update()`. |
### maximum
```
java-static fun maximum(l: Long): FieldValue
```
Returns a special value that can be used with `set()` or `update()` that tells the server to set the field to the maximum of its current value and the given value.
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | The `FieldValue` sentinel for use in a call to `set()` or `update()`. |
### maximum
```
java-static fun maximum(l: Double): FieldValue
```
Returns a special value that can be used with `set()` or `update()` that tells the server to set the field to the maximum of its current value and the given value.
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | The `FieldValue` sentinel for use in a call to `set()` or `update()`. |
### minimum
```
java-static fun minimum(l: Long): FieldValue
```
Returns a special value that can be used with `set()` or `update()` that tells the server to set the field to the minimum of its current value and the given value.
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | The `FieldValue` sentinel for use in a call to `set()` or `update()`. |
### minimum
```
java-static fun minimum(l: Double): FieldValue
```
Returns a special value that can be used with `set()` or `update()` that tells the server to set the field to the minimum of its current value and the given value.
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/FieldValue` | The `FieldValue` sentinel for use in a call to `set()` or `update()`. |
### serverTimestamp
```
java-static fun serverTimestamp(): FieldValue
```
Returns a sentinel for use with `set()` or `update()` to include a server-generated timestamp in the written data.
### vector
```
java-static fun vector(values: DoubleArray): VectorValue
```
Creates a new `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/VectorValue` constructed with a copy of the given array of doubles.
| Parameters |
|---|---|
| `values: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-double-array/index.html` | Array of doubles to be copied to create a `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/VectorValue`. |
| Returns |
|---|---|
| `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/VectorValue` | A new `https://firebase.google.com/docs/reference/kotlin/com/google/firebase/firestore/VectorValue` constructed with a copy of the given array of doubles. |