org.ojai.store

Interface DocumentMutation

All Superinterfaces:

Container, Iterable<MutationOp>, JsonString

@API.Public
 @API.NotThreadSafe
public interface DocumentMutation
extends Iterable<MutationOp>, Container, JsonString

The DocumentMutation interface defines the APIs to perform mutation of a Document already stored in a DocumentStore.

Please see the following notes regarding the behavior of the API types in this Interface.

set()

These APIs validate the type of existing value at the specified FieldPath before applying the mutation. If the field does not exist in the corresponding Document in the DocumentStore, it is created. If the field exists but is not of the same type as the type of new value, then the entire mutation fails.

setOrReplace()

These are performant APIs that do not require or perform a read-modify-write operation on the document store.

If a segment in the specified FieldPath doesn't exist, it is created. For example:

setOrReplace("a.b.c", (int) 10)

In this example, if the Document stored in the DocumentStore has an empty MAP field "a", then a setOrReplace of "a.b.c" will create a field "b" of type MAP under "a". It will also create an field named "c" of type INTEGER under "b" and set its value to 10.

If any segment specified in the FieldPath is of a different type than the existing field segment on the document store, it will be deleted and replaced by a new segment. For example:

setOrReplace("a.b.c", (int) 10)

If the Document stored in the DocumentStore has a field "a" of type array. This operation will delete "a", create new field "a" of type map, add a MAP field "b" under "a" and finally create an INTEGER field "c" with value 10 under "b".

Warning: These are potentially destructive operations since they do not validate existence or type of any field segment in the specified FieldPath.

append()

These operations perform read-modify-write on the document store and will fail if type of any of the intermediate fields segment in the specified FieldPath does not match the type of the corresponding field in the document stored on document store. For example, an append operation on field "a.b.c" will fail if, on the document store, the field "a" itself is an ARRAY or INTEGER.

merge()

If the specified field is of a type other than MAP, then the operation will fail. If the field doesn't exist in the Document on the document store, then this operation will create a new field at the given path. This new field will be of the MAP type and its value will be as specified in the parameter. This operation will fail if any type of intermediate field segment specified in the FieldPath doesn't match the type of the corresponding field in the document stored on the document store. For example, a merge operation on field "a.b.c" will fail if, on the document store, the field "a" itself is an ARRAY or INTEGER.

increment()

If the FieldPath specified for the incremental change doesn't exist in the corresponding Document in the DocumentStore then this operation will create a new field at the given path. This new field will be of same type as the value specified in the parameter.

This operation will fail if the type of any intermediate fields specified in the FieldPath doesn't match the type of the corresponding field in the document stored on the document store. For example, an operation on field "a.b.c" will fail if, on the document store, document a itself is an array or integer.

An increment operation can be applied on any of the numeric types such as byte, short, int, long, float, double, or decimal. The operation will fail if the increment is applied to a field that is of a non-numeric type. The increment operation won't change the type of the existing value stored in the given field for the row. The resultant value of the field will be truncated based on the original type of the field. For example, field 'score' is of type int and contains 60. The increment '5.675', a double, is applied. The resultant value of the field will be 65 (65.675 will be truncated to 65).

Field Summary

Fields

Modifier and Type	Field and Description
static String	MUTATION OJAI field name for the DocumentMutation object.

Method Summary

Modifier and Type	Method and Description
DocumentMutation	append(FieldPath path, byte[] value) Appends the given byte array to an existing BINARY value at the given FieldPath.
DocumentMutation	append(FieldPath path, byte[] value, int offset, int len) Appends the given byte array to an existing BINARY value at the given FieldPath.
DocumentMutation	append(FieldPath path, ByteBuffer value) Appends the given ByteBuffer to an existing BINARY value at the given FieldPath.
DocumentMutation	append(FieldPath path, List<? extends Object> list) Appends elements of the given list to an existing ARRAY at the given FieldPath.
DocumentMutation	append(FieldPath path, String string) Appends the given string to an existing STRING at the given FieldPath.
DocumentMutation	append(String path, byte[] value) Appends the given byte array to an existing BINARY value at the given FieldPath.
DocumentMutation	append(String path, byte[] value, int offset, int len) Appends the given byte array to an existing BINARY value at the given FieldPath.
DocumentMutation	append(String path, ByteBuffer value) Appends the given ByteBuffer to an existing BINARY value at the given FieldPath.
DocumentMutation	append(String path, List<? extends Object> list) Appends elements of the given list to an existing ARRAY at the given FieldPath.
DocumentMutation	append(String path, String string) Appends the given string to an existing STRING at the given FieldPath.
DocumentMutation	decrement(FieldPath path, BigDecimal dec)
DocumentMutation	decrement(FieldPath path, byte dec) Atomically decrements the given field (in dot separated notation) of the given row id.
DocumentMutation	decrement(FieldPath path, double dec)
DocumentMutation	decrement(FieldPath path, float dec)
DocumentMutation	decrement(FieldPath path, int dec)
DocumentMutation	decrement(FieldPath path, long dec)
DocumentMutation	decrement(FieldPath path, short dec)
DocumentMutation	decrement(String path, BigDecimal dec)
DocumentMutation	decrement(String path, byte dec)
DocumentMutation	decrement(String path, double dec)
DocumentMutation	decrement(String path, float dec)
DocumentMutation	decrement(String path, int dec)
DocumentMutation	decrement(String path, long dec)
DocumentMutation	decrement(String path, short dec)
DocumentMutation	delete(FieldPath path) Deletes the field at the given path.
DocumentMutation	delete(String path) Deletes the field at the given path.
DocumentMutation	empty() Empties this DocumentMutation object.
DocumentMutation	increment(FieldPath path, BigDecimal inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(FieldPath path, byte inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(FieldPath path, double inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(FieldPath path, float inc) Atomically increment the field specified by the FieldPath by the given value.
DocumentMutation	increment(FieldPath path, int inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(FieldPath path, long inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(FieldPath path, short inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(String path, BigDecimal inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(String path, byte inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(String path, double inc)
DocumentMutation	increment(String path, float inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(String path, int inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(String path, long inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	increment(String path, short inc) Atomically increment the existing value at given the FieldPath by the given value.
DocumentMutation	merge(FieldPath path, Document doc) Merges the existing MAP at the given FieldPath with the specified Document.
DocumentMutation	merge(FieldPath path, Map<String,Object> map) Merges the existing MAP at the given FieldPath with the specified Map.
DocumentMutation	merge(String path, Document doc) Merges the existing MAP at the given FieldPath with the specified Document.
DocumentMutation	merge(String path, Map<String,Object> map) Merges the existing MAP at the given FieldPath with the specified Map.
DocumentMutation	set(FieldPath path, BigDecimal bd) Sets the field at the given FieldPath to the specified BigDecimal value.
DocumentMutation	set(FieldPath path, boolean b) Sets the field at the given FieldPath to the specified boolean value.
DocumentMutation	set(FieldPath path, byte b) Sets the field at the given FieldPath to the specified byte value.
DocumentMutation	set(FieldPath path, ByteBuffer bb) Sets the field at the given FieldPath to the specified ByteBuffer.
DocumentMutation	set(FieldPath path, Document doc) Sets the field at the given FieldPath to the specified Document.
DocumentMutation	set(FieldPath path, double d) Sets the field at the given FieldPath to the specified double value.
DocumentMutation	set(FieldPath path, float f) Sets the field at the given FieldPath to the specified float value.
DocumentMutation	set(FieldPath path, int i) Sets the field at the given FieldPath to the specified int value.
DocumentMutation	set(FieldPath path, List<? extends Object> list) Sets the field at the given FieldPath to the specified List.
DocumentMutation	set(FieldPath path, long l) Sets the field at the given FieldPath to the specified long value.
DocumentMutation	set(FieldPath path, Map<String,? extends Object> map) Sets the field at the given FieldPath to the specified Map.
DocumentMutation	set(FieldPath path, ODate d) Sets the field at the given FieldPath to the specified Date value.
DocumentMutation	set(FieldPath path, OInterval intv) Sets the field at the given FieldPath to the specified Interval value.
DocumentMutation	set(FieldPath path, OTime t) Sets the field at the given FieldPath to the specified Time value.
DocumentMutation	set(FieldPath path, OTimestamp ts) Sets the field at the given FieldPath to the specified Timestamp value.
DocumentMutation	set(FieldPath path, short s) Sets the field at the given FieldPath to the specified short value.
DocumentMutation	set(FieldPath path, String value) Sets the field at the given FieldPath to the specified String value.
DocumentMutation	set(FieldPath path, Value value) Sets the field at the given FieldPath to the specified value.
DocumentMutation	set(String path, BigDecimal bd) Sets the field at the given FieldPath to the specified BigDecimal value.
DocumentMutation	set(String path, boolean b) Sets the field at the given FieldPath to the specified boolean value.
DocumentMutation	set(String path, byte b) Sets the field at the given FieldPath to the specified byte value.
DocumentMutation	set(String path, ByteBuffer bb) Sets the field at the given FieldPath to the specified ByteBuffer.
DocumentMutation	set(String path, Document doc) Sets the field at the given FieldPath to the specified Document.
DocumentMutation	set(String path, double d) Sets the field at the given FieldPath to the specified double value.
DocumentMutation	set(String path, float f) Sets the field at the given FieldPath to the specified float value.
DocumentMutation	set(String path, int i) Sets the field at the given FieldPath to the specified int value.
DocumentMutation	set(String path, List<? extends Object> list) Sets the field at the given FieldPath to the specified List.
DocumentMutation	set(String path, long l) Sets the field at the given FieldPath to the specified long value.
DocumentMutation	set(String path, Map<String,? extends Object> map) Sets the field at the given FieldPath to the specified Map.
DocumentMutation	set(String path, ODate d) Sets the field at the given FieldPath to the specified Date value.
DocumentMutation	set(String path, OInterval intv) Sets the field at the given FieldPath to the specified Interval value.
DocumentMutation	set(String path, OTime t) Sets the field at the given FieldPath to the specified Time value.
DocumentMutation	set(String path, OTimestamp ts) Sets the field at the given FieldPath to the specified Timestamp value.
DocumentMutation	set(String path, short s) Sets the field at the given FieldPath to the specified short value.
DocumentMutation	set(String path, String value) Sets the field at the given FieldPath to the specified String value.
DocumentMutation	set(String path, Value value) Sets the field at the given FieldPath to the specified value.
DocumentMutation	setNull(FieldPath path) Sets the field at the given FieldPath to NULL Value.
DocumentMutation	setNull(String path) Sets the field at the given FieldPath to NULL Value.
DocumentMutation	setOrReplace(FieldPath path, BigDecimal bd) Sets or replaces the field at the given FieldPath to the specified BigDecimal value.
DocumentMutation	setOrReplace(FieldPath path, boolean b) Sets or replaces the field at the given FieldPath to the specified boolean value.
DocumentMutation	setOrReplace(FieldPath path, byte b) Sets or replaces the field at the given FieldPath to the specified byte value.
DocumentMutation	setOrReplace(FieldPath path, ByteBuffer bb) Sets or replaces the field at the given FieldPath to the specified ByteBuffer.
DocumentMutation	setOrReplace(FieldPath path, Document doc) Sets or replaces the field at the given FieldPath to the specified Document.
DocumentMutation	setOrReplace(FieldPath path, double d) Sets or replaces the field at the given FieldPath to the specified double value.
DocumentMutation	setOrReplace(FieldPath path, float f) Sets or replaces the field at the given FieldPath to the specified float value.
DocumentMutation	setOrReplace(FieldPath path, int i) Sets or replaces the field at the given FieldPath to the specified int value.
DocumentMutation	setOrReplace(FieldPath path, List<? extends Object> list) Sets or replaces the field at the given FieldPath to the specified List.
DocumentMutation	setOrReplace(FieldPath path, long l) Sets or replaces the field at the given FieldPath to the specified long value.
DocumentMutation	setOrReplace(FieldPath path, Map<String,? extends Object> map) Sets or replaces the field at the given FieldPath to the specified Map.
DocumentMutation	setOrReplace(FieldPath path, ODate d) Sets or replaces the field at the given FieldPath to the specified Date value.
DocumentMutation	setOrReplace(FieldPath path, OInterval intv) Sets or replaces the field at the given FieldPath to the specified Interval.
DocumentMutation	setOrReplace(FieldPath path, OTime t) Sets or replaces the field at the given FieldPath to the specified Time value.
DocumentMutation	setOrReplace(FieldPath path, OTimestamp ts) Sets or replaces the field at the given FieldPath to the specified Timestamp value.
DocumentMutation	setOrReplace(FieldPath path, short s) Sets or replaces the field at the given FieldPath to the specified short value.
DocumentMutation	setOrReplace(FieldPath path, String string) Sets or replaces the field at the given FieldPath to the specified String value.
DocumentMutation	setOrReplace(FieldPath path, Value value) Sets or replaces the field at the given FieldPath to the new value.
DocumentMutation	setOrReplace(String path, BigDecimal bd) Sets or replaces the field at the given FieldPath to the specified BigDecimal value.
DocumentMutation	setOrReplace(String path, boolean b) Sets or replaces the field at the given FieldPath to the specified boolean value.
DocumentMutation	setOrReplace(String path, byte b) Sets or replaces the field at the given FieldPath to the specified byte value.
DocumentMutation	setOrReplace(String path, ByteBuffer bb) Sets or replaces the field at the given FieldPath to the specified ByteBuffer.
DocumentMutation	setOrReplace(String path, Document doc) Sets or replaces the field at the given FieldPath to the specified Document.
DocumentMutation	setOrReplace(String path, double d) Sets or replaces the field at the given FieldPath to the specified double value.
DocumentMutation	setOrReplace(String path, float f) Sets or replaces the field at the given FieldPath to the specified float value.
DocumentMutation	setOrReplace(String path, int i) Sets or replaces the field at the given FieldPath to the specified int value.
DocumentMutation	setOrReplace(String path, List<? extends Object> list) Sets or replaces the field at the given FieldPath to the specified List.
DocumentMutation	setOrReplace(String path, long l) Sets or replaces the field at the given FieldPath to the specified long value.
DocumentMutation	setOrReplace(String path, Map<String,? extends Object> map) Sets or replaces the field at the given FieldPath to the specified Map.
DocumentMutation	setOrReplace(String path, ODate d) Sets or replaces the field at the given FieldPath to the specified Date value.
DocumentMutation	setOrReplace(String path, OInterval intv) Sets or replaces the field at the given FieldPath to the specified Interval.
DocumentMutation	setOrReplace(String path, OTime t) Sets or replaces the field at the given FieldPath to the specified Time value.
DocumentMutation	setOrReplace(String path, OTimestamp ts) Sets or replaces the field at the given FieldPath to the specified Timestamp value.
DocumentMutation	setOrReplace(String path, short s) Sets or replaces the field at the given FieldPath to the specified short value.
DocumentMutation	setOrReplace(String path, String string) Sets or replaces the field at the given FieldPath to the specified String value.
DocumentMutation	setOrReplace(String path, Value value) Sets or replaces the field at the given FieldPath to the new value.
DocumentMutation	setOrReplaceNull(FieldPath path) Sets or replaces the field at the given FieldPath to NULL Value.
DocumentMutation	setOrReplaceNull(String path) Sets or replaces the field at the given FieldPath to NULL Value.

Methods inherited from interface java.lang.Iterable

forEach, iterator, spliterator

Methods inherited from interface org.ojai.Container

isEmpty, isReadOnly, size

Methods inherited from interface org.ojai.JsonString

asJsonString, asJsonString

Field Detail

MUTATION

static final String MUTATION

OJAI field name for the DocumentMutation object.

See Also:

Constant Field Values

Method Detail

empty

DocumentMutation empty()

Empties this DocumentMutation object.

Specified by:

empty in interface Container

Returns:

this for chaining.

setNull

DocumentMutation setNull(@API.NonNullable
                         String path)

Sets the field at the given FieldPath to NULL Value.

Parameters:

path - path of the field that needs to be updated

Returns:

this for chained invocation

setNull

DocumentMutation setNull(@API.NonNullable
                         FieldPath path)

Sets the field at the given FieldPath to NULL Value.

Parameters:

path - path of the field that needs to be updated

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     Value value)

Sets the field at the given FieldPath to the specified value.

Parameters:

path - path of the field that needs to be updated

value - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     Value value)

Sets the field at the given FieldPath to the specified value.

Parameters:

path - path of the field that needs to be updated

value - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     boolean b)

Sets the field at the given FieldPath to the specified boolean value.

Parameters:

path - path of the field that needs to be updated

b - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     boolean b)

Sets the field at the given FieldPath to the specified boolean value.

Parameters:

path - path of the field that needs to be updated

b - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     byte b)

Sets the field at the given FieldPath to the specified byte value.

Parameters:

path - path of the field that needs to be updated

b - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     byte b)

Sets the field at the given FieldPath to the specified byte value.

Parameters:

path - path of the field that needs to be updated

b - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     short s)

Sets the field at the given FieldPath to the specified short value.

Parameters:

path - path of the field that needs to be updated

s - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     short s)

Sets the field at the given FieldPath to the specified short value.

Parameters:

path - path of the field that needs to be updated

s - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     int i)

Sets the field at the given FieldPath to the specified int value.

Parameters:

path - path of the field that needs to be updated

i - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     int i)

Sets the field at the given FieldPath to the specified int value.

Parameters:

path - path of the field that needs to be updated

i - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     long l)

Sets the field at the given FieldPath to the specified long value.

Parameters:

path - path of the field that needs to be updated

l - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     long l)

Sets the field at the given FieldPath to the specified long value.

Parameters:

path - path of the field that needs to be updated

l - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     float f)

Sets the field at the given FieldPath to the specified float value.

Parameters:

path - path of the field that needs to be updated

f - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     float f)

Sets the field at the given FieldPath to the specified float value.

Parameters:

path - path of the field that needs to be updated

f - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     double d)

Sets the field at the given FieldPath to the specified double value.

Parameters:

path - path of the field that needs to be updated

d - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     double d)

Sets the field at the given FieldPath to the specified double value.

Parameters:

path - path of the field that needs to be updated

d - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     String value)

Sets the field at the given FieldPath to the specified String value.

Parameters:

path - path of the field that needs to be updated

value - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     String value)

Sets the field at the given FieldPath to the specified String value.

Parameters:

path - path of the field that needs to be updated

value - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     BigDecimal bd)

Sets the field at the given FieldPath to the specified BigDecimal value.

Parameters:

path - path of the field that needs to be updated

bd - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     BigDecimal bd)

Sets the field at the given FieldPath to the specified BigDecimal value.

Parameters:

path - path of the field that needs to be updated

bd - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     ODate d)

Sets the field at the given FieldPath to the specified Date value.

Parameters:

path - path of the field that needs to be updated

d - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     ODate d)

Sets the field at the given FieldPath to the specified Date value.

Parameters:

path - path of the field that needs to be updated

d - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     OTime t)

Sets the field at the given FieldPath to the specified Time value.

Parameters:

path - path of the field that needs to be updated

t - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     OTime t)

Sets the field at the given FieldPath to the specified Time value.

Parameters:

path - path of the field that needs to be updated

t - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     OTimestamp ts)

Sets the field at the given FieldPath to the specified Timestamp value.

Parameters:

path - path of the field that needs to be updated

ts - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     OTimestamp ts)

Sets the field at the given FieldPath to the specified Timestamp value.

Parameters:

path - path of the field that needs to be updated

ts - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     OInterval intv)

Sets the field at the given FieldPath to the specified Interval value.

Parameters:

path - path of the field that needs to be updated

intv - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     OInterval intv)

Sets the field at the given FieldPath to the specified Interval value.

Parameters:

path - path of the field that needs to be updated

intv - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     ByteBuffer bb)

Sets the field at the given FieldPath to the specified ByteBuffer.

Parameters:

path - path of the field that needs to be updated

bb - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     ByteBuffer bb)

Sets the field at the given FieldPath to the specified ByteBuffer.

Parameters:

path - path of the field that needs to be updated

bb - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     List<? extends Object> list)

Sets the field at the given FieldPath to the specified List.

Parameters:

path - path of the field that needs to be updated

list - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     List<? extends Object> list)

Sets the field at the given FieldPath to the specified List.

Parameters:

path - path of the field that needs to be updated

list - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     Map<String,? extends Object> map)

Sets the field at the given FieldPath to the specified Map.

Parameters:

path - path of the field that needs to be updated

map - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     Map<String,? extends Object> map)

Sets the field at the given FieldPath to the specified Map.

Parameters:

path - path of the field that needs to be updated

map - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     String path,
                     @API.NonNullable
                     Document doc)

Sets the field at the given FieldPath to the specified Document.

Parameters:

path - path of the field that needs to be updated

doc - the new value to set at the FieldPath

Returns:

this for chained invocation

set

DocumentMutation set(@API.NonNullable
                     FieldPath path,
                     @API.NonNullable
                     Document doc)

Sets the field at the given FieldPath to the specified Document.

Parameters:

path - path of the field that needs to be updated

doc - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplaceNull

DocumentMutation setOrReplaceNull(@API.NonNullable
                                  String path)

Sets or replaces the field at the given FieldPath to NULL Value.

Parameters:

path - FieldPath in the document that needs to be updated

Returns:

this for chained invocation

setOrReplaceNull

DocumentMutation setOrReplaceNull(@API.NonNullable
                                  FieldPath path)

Sets or replaces the field at the given FieldPath to NULL Value.

Parameters:

path - FieldPath in the document that needs to be updated

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              Value value)

Sets or replaces the field at the given FieldPath to the new value.

Parameters:

path - FieldPath in the document that needs to be updated

value - the new value to set or replace at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              Value value)

Sets or replaces the field at the given FieldPath to the new value.

Parameters:

path - FieldPath in the document that needs to be updated

value - the new value to set or replace at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              boolean b)

Sets or replaces the field at the given FieldPath to the specified boolean value.

Parameters:

path - path of the field that needs to be updated

b - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              boolean b)

Sets or replaces the field at the given FieldPath to the specified boolean value.

Parameters:

path - path of the field that needs to be updated

b - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              byte b)

Sets or replaces the field at the given FieldPath to the specified byte value.

Parameters:

path - path of the field that needs to be updated

b - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              byte b)

Sets or replaces the field at the given FieldPath to the specified byte value.

Parameters:

path - path of the field that needs to be updated

b - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              short s)

Sets or replaces the field at the given FieldPath to the specified short value.

Parameters:

path - path of the field that needs to be updated

s - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              short s)

Sets or replaces the field at the given FieldPath to the specified short value.

Parameters:

path - path of the field that needs to be updated

s - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              int i)

Sets or replaces the field at the given FieldPath to the specified int value.

Parameters:

path - path of the field that needs to be updated

i - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              int i)

Sets or replaces the field at the given FieldPath to the specified int value.

Parameters:

path - path of the field that needs to be updated

i - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              long l)

Sets or replaces the field at the given FieldPath to the specified long value.

Parameters:

path - path of the field that needs to be updated

l - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              long l)

Sets or replaces the field at the given FieldPath to the specified long value.

Parameters:

path - path of the field that needs to be updated

l - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              float f)

Sets or replaces the field at the given FieldPath to the specified float value.

Parameters:

path - path of the field that needs to be updated

f - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              float f)

Sets or replaces the field at the given FieldPath to the specified float value.

Parameters:

path - path of the field that needs to be updated

f - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              double d)

Sets or replaces the field at the given FieldPath to the specified double value.

Parameters:

path - path of the field that needs to be updated

d - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              double d)

Sets or replaces the field at the given FieldPath to the specified double value.

Parameters:

path - path of the field that needs to be updated

d - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              String string)

Sets or replaces the field at the given FieldPath to the specified String value.

Parameters:

path - path of the field that needs to be updated

string - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              String string)

Sets or replaces the field at the given FieldPath to the specified String value.

Parameters:

path - path of the field that needs to be updated

string - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              BigDecimal bd)

Sets or replaces the field at the given FieldPath to the specified BigDecimal value.

Parameters:

path - path of the field that needs to be updated

bd - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              BigDecimal bd)

Sets or replaces the field at the given FieldPath to the specified BigDecimal value.

Parameters:

path - path of the field that needs to be updated

bd - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              ODate d)

Sets or replaces the field at the given FieldPath to the specified Date value.

Parameters:

path - path of the field that needs to be updated

d - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              ODate d)

Sets or replaces the field at the given FieldPath to the specified Date value.

Parameters:

path - path of the field that needs to be updated

d - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              OTime t)

Sets or replaces the field at the given FieldPath to the specified Time value.

Parameters:

path - path of the field that needs to be updated

t - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              OTime t)

Sets or replaces the field at the given FieldPath to the specified Time value.

Parameters:

path - path of the field that needs to be updated

t - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              OTimestamp ts)

Sets or replaces the field at the given FieldPath to the specified Timestamp value.

Parameters:

path - path of the field that needs to be updated

ts - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              OTimestamp ts)

Sets or replaces the field at the given FieldPath to the specified Timestamp value.

Parameters:

path - path of the field that needs to be updated

ts - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              OInterval intv)

Sets or replaces the field at the given FieldPath to the specified Interval.

Parameters:

path - path of the field that needs to be updated

intv - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              OInterval intv)

Sets or replaces the field at the given FieldPath to the specified Interval.

Parameters:

path - path of the field that needs to be updated

intv - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              ByteBuffer bb)

Sets or replaces the field at the given FieldPath to the specified ByteBuffer.

Parameters:

path - path of the field that needs to be updated

bb - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              ByteBuffer bb)

Sets or replaces the field at the given FieldPath to the specified ByteBuffer.

Parameters:

path - path of the field that needs to be updated

bb - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              List<? extends Object> list)

Sets or replaces the field at the given FieldPath to the specified List.

Parameters:

path - path of the field that needs to be updated

list - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              List<? extends Object> list)

Sets or replaces the field at the given FieldPath to the specified List.

Parameters:

path - path of the field that needs to be updated

list - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              Map<String,? extends Object> map)

Sets or replaces the field at the given FieldPath to the specified Map.

Parameters:

path - path of the field that needs to be updated

map - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              Map<String,? extends Object> map)

Sets or replaces the field at the given FieldPath to the specified Map.

Parameters:

path - path of the field that needs to be updated

map - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              String path,
                              @API.NonNullable
                              Document doc)

Sets or replaces the field at the given FieldPath to the specified Document.

Parameters:

path - path of the field that needs to be updated

doc - the new value to set at the FieldPath

Returns:

this for chained invocation

setOrReplace

DocumentMutation setOrReplace(@API.NonNullable
                              FieldPath path,
                              @API.NonNullable
                              Document doc)

Sets or replaces the field at the given FieldPath to the specified Document.

Parameters:

path - path of the field that needs to be updated

doc - the new value to set at the FieldPath

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        String path,
                        @API.NonNullable
                        List<? extends Object> list)

Appends elements of the given list to an existing ARRAY at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the specified List. If the field already exists, but is not of ARRAY type, then this operation will fail.

Parameters:

path - path of the field that needs to be appended

list - the List to append at the FieldPath

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        FieldPath path,
                        @API.NonNullable
                        List<? extends Object> list)

Appends elements of the given list to an existing ARRAY at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the specified List. If the field already exists, but is not of ARRAY type, then this operation will fail.

Parameters:

path - path of the field that needs to be appended

list - the List to append at the FieldPath

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        String path,
                        @API.NonNullable
                        String string)

Appends the given string to an existing STRING at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the specified String. If the field already exists, but is not of STRING type, then this operation will fail.

Parameters:

path - path of the field that needs to be appended

string - the String to append at the FieldPath

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        FieldPath path,
                        @API.NonNullable
                        String string)

Appends the given string to an existing STRING at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the specified String. If the field already exists, but is not of STRING type, then this operation will fail.

Parameters:

path - path of the field that needs to be appended

string - the String to append at the FieldPath

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        String path,
                        @API.NonNullable
                        byte[] value,
                        int offset,
                        int len)

Appends the given byte array to an existing BINARY value at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the BINARY value specified by the given byte array. If the field already exists, but is not of BINARY type, then this operation will fail.

Parameters:

path - the FieldPath to apply this append operation

value - the byte array to append

offset - offset in byte array

len - length in byte array

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        FieldPath path,
                        @API.NonNullable
                        byte[] value,
                        int offset,
                        int len)

Appends the given byte array to an existing BINARY value at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the BINARY value specified by the given byte array. If the field already exists, but is not of BINARY type, then this operation will fail.

Parameters:

path - the FieldPath to apply this append operation

value - the byte array to append

offset - offset in byte array

len - length in byte array

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        String path,
                        @API.NonNullable
                        byte[] value)

Appends the given byte array to an existing BINARY value at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the BINARY value specified by the given byte array. If the field already exists, but is not of BINARY type, then this operation will fail.

Parameters:

path - the FieldPath to apply this append operation

value - the byte array to append

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        FieldPath path,
                        @API.NonNullable
                        byte[] value)

Appends the given byte array to an existing BINARY value at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the BINARY value specified by the given byte array. If the field already exists, but is not of BINARY type, then this operation will fail.

Parameters:

path - the FieldPath to apply this append operation

value - the byte array to append

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        String path,
                        @API.NonNullable
                        ByteBuffer value)

Appends the given ByteBuffer to an existing BINARY value at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the BINARY value specified by the given ByteBuffer. If the field already exists, but is not of BINARY type, then this operation will fail.

Parameters:

path - the FieldPath to apply this append operation

value - the ByteBuffer to append

Returns:

this for chained invocation

append

DocumentMutation append(@API.NonNullable
                        FieldPath path,
                        @API.NonNullable
                        ByteBuffer value)

Appends the given ByteBuffer to an existing BINARY value at the given FieldPath.

If the field doesn't exist on document store, it will be created and will be set to the BINARY value specified by the given ByteBuffer. If the field already exists, but is not of BINARY type, then this operation will fail.

Parameters:

path - the FieldPath to apply this append operation

value - the ByteBuffer to append

Returns:

this for chained invocation

merge

DocumentMutation merge(@API.NonNullable
                       String path,
                       @API.NonNullable
                       Document doc)

Merges the existing MAP at the given FieldPath with the specified Document.

Parameters:

path - the FieldPath to apply this merge operation

doc - the document to be merged

Returns:

this for chained invocation

merge

DocumentMutation merge(@API.NonNullable
                       FieldPath path,
                       @API.NonNullable
                       Document doc)

Merges the existing MAP at the given FieldPath with the specified Document.

Parameters:

path - the FieldPath to apply this merge operation

doc - the document to be merged

Returns:

this for chained invocation

merge

DocumentMutation merge(@API.NonNullable
                       String path,
                       @API.NonNullable
                       Map<String,Object> map)

Merges the existing MAP at the given FieldPath with the specified Map.

Parameters:

path - the FieldPath to apply this merge operation

map - the Map to be merged

Returns:

this for chained invocation

merge

DocumentMutation merge(@API.NonNullable
                       FieldPath path,
                       @API.NonNullable
                       Map<String,Object> map)

Merges the existing MAP at the given FieldPath with the specified Map.

Parameters:

path - the FieldPath to apply this merge operation

map - the Map to be merged

Returns:

this for chained invocation

increment

DocumentMutation increment(@API.NonNullable
                           FieldPath path,
                           byte inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           String path,
                           byte inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           FieldPath path,
                           short inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           String path,
                           short inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           String path,
                           int inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           FieldPath path,
                           int inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           FieldPath path,
                           long inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           String path,
                           long inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           String path,
                           float inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           FieldPath path,
                           float inc)

Atomically increment the field specified by the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           String path,
                           double inc)

increment

DocumentMutation increment(@API.NonNullable
                           FieldPath path,
                           double inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           String path,
                           @API.NonNullable
                           BigDecimal inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

increment

DocumentMutation increment(@API.NonNullable
                           FieldPath path,
                           @API.NonNullable
                           BigDecimal inc)

Atomically increment the existing value at given the FieldPath by the given value.

Parameters:

path - the FieldPath to apply this increment operation

inc - increment to apply to a field - can be positive or negative

decrement

DocumentMutation decrement(@API.NonNullable
                           FieldPath path,
                           byte dec)

Atomically decrements the given field (in dot separated notation) of the given row id. If the field path specified for the decrement operation doesn't exist in the document in document store, then this operation will create a new element at the given path. This new element will be of same type as the value specified in the parameter. This operation will fail if the type of any intermediate path elements specified in the append field path doesn't match the type of the corresponding field in the document stored on the document store. For example, an operation on field "a.b.c" will fail if, on the document store, document a itself is an array or integer. If the field doesn't exist in the document store then it will be created with the type of given decremental value. A decrement operation can be applied on any of the numeric types of a field, such as byte, short, int, long, float, double, or decimal. The operation will fail if the decrement is applied to a field that is of a non-numeric type. The decrement operation won't change the type of the existing value stored in the given field for the row. The resultant value of the field will be truncated based on the original type of the field. For example, field 'score' is of type int and contains 60. The decrement '5.675', a double, is applied. The resultant value of the field will be 54 (54.325 will be truncated to 54).

Parameters:

path - field name in dot separated notation

dec - decrement to apply to a field - can be positive or negative

Throws:

IOException

decrement

DocumentMutation decrement(@API.NonNullable
                           String path,
                           byte dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           FieldPath path,
                           short dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           String path,
                           short dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           String path,
                           int dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           FieldPath path,
                           int dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           FieldPath path,
                           long dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           String path,
                           long dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           String path,
                           float dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           FieldPath path,
                           float dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           String path,
                           double dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           FieldPath path,
                           double dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           String path,
                           @API.NonNullable
                           BigDecimal dec)

decrement

DocumentMutation decrement(@API.NonNullable
                           FieldPath path,
                           @API.NonNullable
                           BigDecimal dec)

delete

DocumentMutation delete(@API.NonNullable
                        String path)

Deletes the field at the given path.

If the field does not exist, the mutation operation will silently succeed. For example, if a delete operation is attempted on "a.b.c", and the field "a.b" is an array, then "a.b.c" will not be deleted.

Parameters:

path - the FieldPath to delete

delete

DocumentMutation delete(@API.NonNullable
                        FieldPath path)

Deletes the field at the given path.

If the field does not exist, the mutation operation will silently succeed. For example, if a delete operation is attempted on "a.b.c", and the field "a.b" is an array, then "a.b.c" will not be deleted.

Parameters:

path - the FieldPath to delete