Class TransactionalBatchPatchItemRequestOptions

Namespace

Microsoft.Azure.Cosmos

Assembly

Microsoft.Azure.Cosmos.Client.dll

Cosmos Batch Patch request options

public class TransactionalBatchPatchItemRequestOptions : TransactionalBatchItemRequestOptions

Inheritance

object

RequestOptions

TransactionalBatchItemRequestOptions

TransactionalBatchPatchItemRequestOptions

Inherited Members

TransactionalBatchItemRequestOptions.IndexingDirective

TransactionalBatchItemRequestOptions.EnableContentResponseOnWrite

RequestOptions.ShallowCopy()

RequestOptions.IfMatchEtag

RequestOptions.IfNoneMatchEtag

RequestOptions.Properties

RequestOptions.AddRequestHeaders

RequestOptions.PriorityLevel

RequestOptions.CosmosThresholdOptions

RequestOptions.ExcludeRegions

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

CosmosLinqExtensions.DocumentId(object)

CosmosLinqExtensions.IsArray(object)

CosmosLinqExtensions.IsBool(object)

CosmosLinqExtensions.IsDefined(object)

CosmosLinqExtensions.IsNull(object)

CosmosLinqExtensions.IsNumber(object)

CosmosLinqExtensions.IsObject(object)

CosmosLinqExtensions.IsPrimitive(object)

CosmosLinqExtensions.IsString(object)

CosmosLinqExtensions.RegexMatch(object, string, string)

CosmosLinqExtensions.RegexMatch(object, string)

Constructors

TransactionalBatchPatchItemRequestOptions()

public TransactionalBatchPatchItemRequestOptions()

Properties

FilterPredicate

Gets or sets condition to be checked before the patch operations in the Azure Cosmos DB service.

public string FilterPredicate { get; set; }

Property Value

string

The condition to be checked before execution of operations.

Remarks

Condition can only be a sql statement. Creates a conditional SQL argument which is of format from-clause, the condition has to be within the scope of the document which is supposed to be patched in the particular request. If the condition is satisfied (given document meets the given from-clause SQL statement), the patch transaction will take place otherwise it will be returned with precondition failed.