/
PatchItemRequestOptions.xml
76 lines (76 loc) · 3.82 KB
/
PatchItemRequestOptions.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
<Type Name="PatchItemRequestOptions" FullName="Microsoft.Azure.Cosmos.PatchItemRequestOptions">
<TypeSignature Language="C#" Value="public sealed class PatchItemRequestOptions : Microsoft.Azure.Cosmos.ItemRequestOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit PatchItemRequestOptions extends Microsoft.Azure.Cosmos.ItemRequestOptions" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.PatchItemRequestOptions" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class PatchItemRequestOptions
Inherits ItemRequestOptions" />
<TypeSignature Language="F#" Value="type PatchItemRequestOptions = class
 inherit ItemRequestOptions" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.36.0.0</AssemblyVersion>
<AssemblyVersion>3.38.1.0</AssemblyVersion>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Cosmos.ItemRequestOptions</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Cosmos Patch request options
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PatchItemRequestOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.PatchItemRequestOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FilterPredicate">
<MemberSignature Language="C#" Value="public string FilterPredicate { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FilterPredicate" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Cosmos.PatchItemRequestOptions.FilterPredicate" />
<MemberSignature Language="VB.NET" Value="Public Property FilterPredicate As String" />
<MemberSignature Language="F#" Value="member this.FilterPredicate : string with get, set" Usage="Microsoft.Azure.Cosmos.PatchItemRequestOptions.FilterPredicate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.39.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets condition to be checked before the patch operations in the Azure Cosmos DB service.
</summary>
<value>
The condition to be checked before execution of operations.
</value>
<remarks>
Condition can only be a from-clause of a sql statement.
Creates a conditional SQL argument which is of format "FROM X where CONDITION",
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 the patch transaction will take place otherwise it will be returned with precondition failed.
</remarks>
<sample>
PatchItemRequestOptions requestOptions = new PatchItemRequestOptions()
{
FilterPredicate = "from c where c.taskNum = 3"
};
</sample>
</Docs>
</Member>
</Members>
</Type>