-
Notifications
You must be signed in to change notification settings - Fork 256
/
ConsistencyPolicy.xml
199 lines (199 loc) · 11.8 KB
/
ConsistencyPolicy.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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
<Type Name="ConsistencyPolicy" FullName="Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy">
<TypeSignature Language="C#" Value="public class ConsistencyPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ConsistencyPolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy" />
<TypeSignature Language="VB.NET" Value="Public Class ConsistencyPolicy" />
<TypeSignature Language="F#" Value="type ConsistencyPolicy = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
<AssemblyVersion>3.2.0.0</AssemblyVersion>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The consistency policy for the Cosmos DB database account.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConsistencyPolicy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
<AssemblyVersion>3.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the ConsistencyPolicy class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ConsistencyPolicy (Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel defaultConsistencyLevel, long? maxStalenessPrefix = default, int? maxIntervalInSeconds = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel defaultConsistencyLevel, valuetype System.Nullable`1<int64> maxStalenessPrefix, valuetype System.Nullable`1<int32> maxIntervalInSeconds) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.#ctor(Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel,System.Nullable{System.Int64},System.Nullable{System.Int32})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (defaultConsistencyLevel As DefaultConsistencyLevel, Optional maxStalenessPrefix As Nullable(Of Long) = Nothing, Optional maxIntervalInSeconds As Nullable(Of Integer) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy : Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel * Nullable<int64> * Nullable<int> -> Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy" Usage="new Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy (defaultConsistencyLevel, maxStalenessPrefix, maxIntervalInSeconds)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
<AssemblyVersion>3.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="defaultConsistencyLevel" Type="Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel" />
<Parameter Name="maxStalenessPrefix" Type="System.Nullable<System.Int64>" />
<Parameter Name="maxIntervalInSeconds" Type="System.Nullable<System.Int32>" />
</Parameters>
<Docs>
<param name="defaultConsistencyLevel">The default consistency level
and configuration settings of the Cosmos DB account. Possible
values include: 'Eventual', 'Session', 'BoundedStaleness',
'Strong', 'ConsistentPrefix'</param>
<param name="maxStalenessPrefix">When used with the Bounded
Staleness consistency level, this value represents the number of
stale requests tolerated. Accepted range for this value is 1 –
2,147,483,647. Required when defaultConsistencyPolicy is set to
'BoundedStaleness'.</param>
<param name="maxIntervalInSeconds">When used with the Bounded
Staleness consistency level, this value represents the time amount
of staleness (in seconds) tolerated. Accepted range for this value
is 5 - 86400. Required when defaultConsistencyPolicy is set to
'BoundedStaleness'.</param>
<summary>
Initializes a new instance of the ConsistencyPolicy class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultConsistencyLevel">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel DefaultConsistencyLevel { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel DefaultConsistencyLevel" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.DefaultConsistencyLevel" />
<MemberSignature Language="VB.NET" Value="Public Property DefaultConsistencyLevel As DefaultConsistencyLevel" />
<MemberSignature Language="F#" Value="member this.DefaultConsistencyLevel : Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.DefaultConsistencyLevel" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
<AssemblyVersion>3.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="defaultConsistencyLevel")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="defaultConsistencyLevel")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.CosmosDB.Models.DefaultConsistencyLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the default consistency level and configuration
settings of the Cosmos DB account. Possible values include:
'Eventual', 'Session', 'BoundedStaleness', 'Strong',
'ConsistentPrefix'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxIntervalInSeconds">
<MemberSignature Language="C#" Value="public int? MaxIntervalInSeconds { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> MaxIntervalInSeconds" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.MaxIntervalInSeconds" />
<MemberSignature Language="VB.NET" Value="Public Property MaxIntervalInSeconds As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.MaxIntervalInSeconds : Nullable<int> with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.MaxIntervalInSeconds" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
<AssemblyVersion>3.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxIntervalInSeconds")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxIntervalInSeconds")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets when used with the Bounded Staleness consistency
level, this value represents the time amount of staleness (in
seconds) tolerated. Accepted range for this value is 5 - 86400.
Required when defaultConsistencyPolicy is set to
'BoundedStaleness'.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="MaxStalenessPrefix">
<MemberSignature Language="C#" Value="public long? MaxStalenessPrefix { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int64> MaxStalenessPrefix" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.MaxStalenessPrefix" />
<MemberSignature Language="VB.NET" Value="Public Property MaxStalenessPrefix As Nullable(Of Long)" />
<MemberSignature Language="F#" Value="member this.MaxStalenessPrefix : Nullable<int64> with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.MaxStalenessPrefix" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
<AssemblyVersion>3.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="maxStalenessPrefix")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="maxStalenessPrefix")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Int64></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets when used with the Bounded Staleness consistency
level, this value represents the number of stale requests
tolerated. Accepted range for this value is 1 – 2,147,483,647.
Required when defaultConsistencyPolicy is set to
'BoundedStaleness'.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Models.ConsistencyPolicy.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="consistencyPolicy.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB</AssemblyName>
<AssemblyVersion>3.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Validate the object.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.Rest.ValidationException">
Thrown if validation fails
</exception>
</Docs>
</Member>
</Members>
</Type>