-
Notifications
You must be signed in to change notification settings - Fork 254
/
IndexingPolicyDefinition`1.xml
215 lines (215 loc) · 14 KB
/
IndexingPolicyDefinition`1.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
<Type Name="IndexingPolicyDefinition<T>" FullName="Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>">
<TypeSignature Language="C#" Value="public class IndexingPolicyDefinition<T>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit IndexingPolicyDefinition`1<T> extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1" />
<TypeSignature Language="VB.NET" Value="Public Class IndexingPolicyDefinition(Of T)" />
<TypeSignature Language="F#" Value="type IndexingPolicyDefinition<'T> = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<typeparam name="T">To be added.</typeparam>
<summary>
Indexing Policy fluent definition.
</summary>
<remarks>To be added.</remarks>
<altmember cref="T:Microsoft.Azure.Cosmos.IndexingPolicy" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IndexingPolicyDefinition ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Creates an instance for unit-testing
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Attach">
<MemberSignature Language="C#" Value="public T Attach ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance !T Attach() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1.Attach" />
<MemberSignature Language="VB.NET" Value="Public Function Attach () As T" />
<MemberSignature Language="F#" Value="member this.Attach : unit -> 'T" Usage="indexingPolicyDefinition.Attach " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Applies the current definition to the parent.
</summary>
<returns>An instance of the parent.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithAutomaticIndexing">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T> WithAutomaticIndexing (bool enabled);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1<!T> WithAutomaticIndexing(bool enabled) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1.WithAutomaticIndexing(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function WithAutomaticIndexing (enabled As Boolean) As IndexingPolicyDefinition(Of T)" />
<MemberSignature Language="F#" Value="member this.WithAutomaticIndexing : bool -> Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<'T>" Usage="indexingPolicyDefinition.WithAutomaticIndexing enabled" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="enabled" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="enabled">Defines whether Automatic Indexing is enabled or not.</param>
<summary>
Defines the <see cref="T:Microsoft.Azure.Cosmos.Container" />'s automatic indexing.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithCompositeIndex">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.Fluent.CompositeIndexDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>> WithCompositeIndex ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Cosmos.Fluent.CompositeIndexDefinition`1<class Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1<!T>> WithCompositeIndex() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1.WithCompositeIndex" />
<MemberSignature Language="VB.NET" Value="Public Function WithCompositeIndex () As CompositeIndexDefinition(Of IndexingPolicyDefinition(Of T))" />
<MemberSignature Language="F#" Value="member this.WithCompositeIndex : unit -> Microsoft.Azure.Cosmos.Fluent.CompositeIndexDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<'T>>" Usage="indexingPolicyDefinition.WithCompositeIndex " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Fluent.CompositeIndexDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Defines a Composite Index in the current <see cref="T:Microsoft.Azure.Cosmos.Container" />'s definition.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.Fluent.CompositeIndexDefinition`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithExcludedPaths">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.Fluent.PathsDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>> WithExcludedPaths ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Cosmos.Fluent.PathsDefinition`1<class Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1<!T>> WithExcludedPaths() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1.WithExcludedPaths" />
<MemberSignature Language="VB.NET" Value="Public Function WithExcludedPaths () As PathsDefinition(Of IndexingPolicyDefinition(Of T))" />
<MemberSignature Language="F#" Value="member this.WithExcludedPaths : unit -> Microsoft.Azure.Cosmos.Fluent.PathsDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<'T>>" Usage="indexingPolicyDefinition.WithExcludedPaths " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Fluent.PathsDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Defines the <see cref="T:Microsoft.Azure.Cosmos.Container" />'s <see cref="P:Microsoft.Azure.Cosmos.IndexingPolicy.ExcludedPaths" />.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.Fluent.PathsDefinition`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithIncludedPaths">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.Fluent.PathsDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>> WithIncludedPaths ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Cosmos.Fluent.PathsDefinition`1<class Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1<!T>> WithIncludedPaths() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1.WithIncludedPaths" />
<MemberSignature Language="VB.NET" Value="Public Function WithIncludedPaths () As PathsDefinition(Of IndexingPolicyDefinition(Of T))" />
<MemberSignature Language="F#" Value="member this.WithIncludedPaths : unit -> Microsoft.Azure.Cosmos.Fluent.PathsDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<'T>>" Usage="indexingPolicyDefinition.WithIncludedPaths " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Fluent.PathsDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Defines the <see cref="T:Microsoft.Azure.Cosmos.Container" />'s <see cref="P:Microsoft.Azure.Cosmos.IndexingPolicy.IncludedPaths" />.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.Fluent.PathsDefinition`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithIndexingMode">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T> WithIndexingMode (Microsoft.Azure.Cosmos.IndexingMode indexingMode);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1<!T> WithIndexingMode(valuetype Microsoft.Azure.Cosmos.IndexingMode indexingMode) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1.WithIndexingMode(Microsoft.Azure.Cosmos.IndexingMode)" />
<MemberSignature Language="VB.NET" Value="Public Function WithIndexingMode (indexingMode As IndexingMode) As IndexingPolicyDefinition(Of T)" />
<MemberSignature Language="F#" Value="member this.WithIndexingMode : Microsoft.Azure.Cosmos.IndexingMode -> Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<'T>" Usage="indexingPolicyDefinition.WithIndexingMode indexingMode" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="indexingMode" Type="Microsoft.Azure.Cosmos.IndexingMode" />
</Parameters>
<Docs>
<param name="indexingMode">An <see cref="T:Microsoft.Azure.Cosmos.IndexingMode" /></param>
<summary>
Defines the <see cref="T:Microsoft.Azure.Cosmos.Container" />'s <see cref="T:Microsoft.Azure.Cosmos.IndexingMode" />.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1" />.</returns>
<remarks>
If multiple calls are made to this method within the same <see cref="T:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1" />, the last one will apply.
</remarks>
</Docs>
</Member>
<Member MemberName="WithSpatialIndex">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Cosmos.Fluent.SpatialIndexDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>> WithSpatialIndex ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Azure.Cosmos.Fluent.SpatialIndexDefinition`1<class Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1<!T>> WithSpatialIndex() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition`1.WithSpatialIndex" />
<MemberSignature Language="VB.NET" Value="Public Function WithSpatialIndex () As SpatialIndexDefinition(Of IndexingPolicyDefinition(Of T))" />
<MemberSignature Language="F#" Value="member this.WithSpatialIndex : unit -> Microsoft.Azure.Cosmos.Fluent.SpatialIndexDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<'T>>" Usage="indexingPolicyDefinition.WithSpatialIndex " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Cosmos.Client</AssemblyName>
<AssemblyVersion>3.16.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Cosmos.Fluent.SpatialIndexDefinition<Microsoft.Azure.Cosmos.Fluent.IndexingPolicyDefinition<T>></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Defines a <see cref="T:Microsoft.Azure.Cosmos.SpatialIndex" /> in the current <see cref="T:Microsoft.Azure.Cosmos.Container" />'s definition.
</summary>
<returns>An instance of <see cref="T:Microsoft.Azure.Cosmos.Fluent.SpatialIndexDefinition`1" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>