BatchOperationPatch<T extends BaseDocument> class

Batch operation for patching documents in the target container.

Inheritance

Implemented types

Constructors

BatchOperationPatch(String id, {PartitionKey? partitionKey}): Creates a batch operation for patching document with id.

hashCode → int: The hash code for this object.
no setterinherited
id → String: The target document id.
final
partitionKey → PartitionKey?: The operation's target partitionKey.
no setterinherited
result → BatchOperationResult<T>?: The operation's result. This property will be set after calling Batch.execute; it returns null if the batch has not been executed yet.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
type → BatchOperationType: The operation's type.
final

add(String path, dynamic value) → void: Adds a property identified by path with value to the target document.
override
decrement(String path, [num value = 1]) → void: Decrements the property identified by path by value in the target document.
override
increment(String path, [num value = 1]) → void: Increments the property identified by path by value in the target document.
override
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
remove(String path) → void: Removes the property identified by path from the target document.
override
replace(String path, dynamic value) → void: Replaces the property identified by path with value in the target document.
override
set(String path, dynamic value) → void: Sets the property identified by path with value in the target document.
override
setCondition(String condition) → void: Sets the condition to decide whether this patch should be applied to the target document.
override
toJson() → Map<String, dynamic>: Serializes this instance to a JSON object.
override
toString() → String: A string representation of this object.
inherited
withParam(String name, dynamic value) → void: Registers a parameter's value, used in the patch's condition.
override