/
IndexingPolicy.xml
246 lines (246 loc) · 17.9 KB
/
IndexingPolicy.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
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
<Type Name="IndexingPolicy" FullName="Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy">
<TypeSignature Language="C#" Value="public class IndexingPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IndexingPolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy" />
<TypeSignature Language="VB.NET" Value="Public Class IndexingPolicy" />
<TypeSignature Language="F#" Value="type IndexingPolicy = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Cosmos DB indexing policy
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IndexingPolicy ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the IndexingPolicy class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IndexingPolicy (bool? automatic = default, Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode indexingMode = default, System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath> includedPaths = default, System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath> excludedPaths = default, System.Collections.Generic.IList<System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath>> compositeIndexes = default, System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec> spatialIndexes = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Nullable`1<bool> automatic, class Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode indexingMode, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath> includedPaths, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath> excludedPaths, class System.Collections.Generic.IList`1<class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath>> compositeIndexes, class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec> spatialIndexes) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.#ctor(System.Nullable{System.Boolean},Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode,System.Collections.Generic.IList{Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath},System.Collections.Generic.IList{Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath},System.Collections.Generic.IList{System.Collections.Generic.IList{Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath}},System.Collections.Generic.IList{Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (Optional automatic As Nullable(Of Boolean) = Nothing, Optional indexingMode As IndexingMode = Nothing, Optional includedPaths As IList(Of IncludedPath) = Nothing, Optional excludedPaths As IList(Of ExcludedPath) = Nothing, Optional compositeIndexes As IList(Of IList(Of CompositePath)) = Nothing, Optional spatialIndexes As IList(Of SpatialSpec) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy : Nullable<bool> * Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode * System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath> * System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath> * System.Collections.Generic.IList<System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath>> * System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec> -> Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy" Usage="new Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy (automatic, indexingMode, includedPaths, excludedPaths, compositeIndexes, spatialIndexes)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="automatic" Type="System.Nullable<System.Boolean>" />
<Parameter Name="indexingMode" Type="Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode" />
<Parameter Name="includedPaths" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath>" />
<Parameter Name="excludedPaths" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath>" />
<Parameter Name="compositeIndexes" Type="System.Collections.Generic.IList<System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath>>" />
<Parameter Name="spatialIndexes" Type="System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec>" />
</Parameters>
<Docs>
<param name="automatic">Indicates if the indexing policy is
automatic</param>
<param name="indexingMode">Indicates the indexing mode. Possible
values include: 'Consistent', 'Lazy', 'None'</param>
<param name="includedPaths">List of paths to include in the
indexing</param>
<param name="excludedPaths">List of paths to exclude from
indexing</param>
<param name="compositeIndexes">List of composite path list</param>
<param name="spatialIndexes">List of spatial specifics</param>
<summary>
Initializes a new instance of the IndexingPolicy class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Automatic">
<MemberSignature Language="C#" Value="public bool? Automatic { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> Automatic" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.Automatic" />
<MemberSignature Language="VB.NET" Value="Public Property Automatic As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.Automatic : Nullable<bool> with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.Automatic" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="automatic")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="automatic")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets indicates if the indexing policy is automatic
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CompositeIndexes">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath>> CompositeIndexes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath>> CompositeIndexes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.CompositeIndexes" />
<MemberSignature Language="VB.NET" Value="Public Property CompositeIndexes As IList(Of IList(Of CompositePath))" />
<MemberSignature Language="F#" Value="member this.CompositeIndexes : System.Collections.Generic.IList<System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath>> with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.CompositeIndexes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="compositeIndexes")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="compositeIndexes")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.CompositePath>></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets list of composite path list
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExcludedPaths">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath> ExcludedPaths { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath> ExcludedPaths" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.ExcludedPaths" />
<MemberSignature Language="VB.NET" Value="Public Property ExcludedPaths As IList(Of ExcludedPath)" />
<MemberSignature Language="F#" Value="member this.ExcludedPaths : System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath> with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.ExcludedPaths" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="excludedPaths")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="excludedPaths")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.ExcludedPath></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets list of paths to exclude from indexing
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IncludedPaths">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath> IncludedPaths { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath> IncludedPaths" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.IncludedPaths" />
<MemberSignature Language="VB.NET" Value="Public Property IncludedPaths As IList(Of IncludedPath)" />
<MemberSignature Language="F#" Value="member this.IncludedPaths : System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath> with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.IncludedPaths" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="includedPaths")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="includedPaths")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.IncludedPath></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets list of paths to include in the indexing
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IndexingMode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode IndexingMode { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode IndexingMode" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.IndexingMode" />
<MemberSignature Language="VB.NET" Value="Public Property IndexingMode As IndexingMode" />
<MemberSignature Language="F#" Value="member this.IndexingMode : Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.IndexingMode" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="indexingMode")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="indexingMode")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingMode</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets indicates the indexing mode. Possible values include:
'Consistent', 'Lazy', 'None'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SpatialIndexes">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec> SpatialIndexes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec> SpatialIndexes" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.SpatialIndexes" />
<MemberSignature Language="VB.NET" Value="Public Property SpatialIndexes As IList(Of SpatialSpec)" />
<MemberSignature Language="F#" Value="member this.SpatialIndexes : System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec> with get, set" Usage="Microsoft.Azure.Management.CosmosDB.Fluent.Models.IndexingPolicy.SpatialIndexes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Management.CosmosDB.Fluent</AssemblyName>
<AssemblyVersion>1.0.0.71</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="spatialIndexes")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="spatialIndexes")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Management.CosmosDB.Fluent.Models.SpatialSpec></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets list of spatial specifics
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>