-
Notifications
You must be signed in to change notification settings - Fork 256
/
IndexAction.xml
194 lines (194 loc) · 11.3 KB
/
IndexAction.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
<Type Name="IndexAction" FullName="Microsoft.Azure.Search.Models.IndexAction">
<TypeSignature Language="C#" Value="public static class IndexAction" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit IndexAction extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.IndexAction" />
<TypeSignature Language="VB.NET" Value="Public Class IndexAction" />
<TypeSignature Language="F#" Value="type IndexAction = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides factory methods for creating an index action that operates on a document.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Delete">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.IndexAction<Microsoft.Azure.Search.Models.Document> Delete (string keyName, string keyValue);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.IndexAction`1<class Microsoft.Azure.Search.Models.Document> Delete(string keyName, string keyValue) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.IndexAction.Delete(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Delete (keyName As String, keyValue As String) As IndexAction(Of Document)" />
<MemberSignature Language="F#" Value="static member Delete : string * string -> Microsoft.Azure.Search.Models.IndexAction<Microsoft.Azure.Search.Models.Document>" Usage="Microsoft.Azure.Search.Models.IndexAction.Delete (keyName, keyValue)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.IndexAction<Microsoft.Azure.Search.Models.Document></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyName" Type="System.String" />
<Parameter Name="keyValue" Type="System.String" />
</Parameters>
<Docs>
<param name="keyName">The name of the key field of the index.</param>
<param name="keyValue">The key of the document to delete.</param>
<summary>
Creates a new IndexAction for deleting a document.
</summary>
<returns>A new IndexAction.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Delete<T>">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.IndexAction<T> Delete<T> (T document);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.IndexAction`1<!!T> Delete<T>(!!T document) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.IndexAction.Delete``1(``0)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Delete(Of T) (document As T) As IndexAction(Of T)" />
<MemberSignature Language="F#" Value="static member Delete : 'T -> Microsoft.Azure.Search.Models.IndexAction<'T>" Usage="Microsoft.Azure.Search.Models.IndexAction.Delete document" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.IndexAction<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="document" Type="T" />
</Parameters>
<Docs>
<typeparam name="T">
The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index.
</typeparam>
<param name="document">The document to delete; Fields other than the key are ignored.</param>
<summary>
Creates a new IndexAction for deleting a document.
</summary>
<returns>A new IndexAction.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Merge<T>">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.IndexAction<T> Merge<T> (T document);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.IndexAction`1<!!T> Merge<T>(!!T document) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.IndexAction.Merge``1(``0)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Merge(Of T) (document As T) As IndexAction(Of T)" />
<MemberSignature Language="F#" Value="static member Merge : 'T -> Microsoft.Azure.Search.Models.IndexAction<'T>" Usage="Microsoft.Azure.Search.Models.IndexAction.Merge document" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.IndexAction<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="document" Type="T" />
</Parameters>
<Docs>
<typeparam name="T">
The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index.
</typeparam>
<param name="document">The document to merge; Set only the properties that you want to change.</param>
<summary>
Creates a new IndexAction for merging a document into an existing document in the index.
</summary>
<returns>A new IndexAction.</returns>
<remarks>
<para>If type T contains non-nullable value-typed properties, these properties may not merge correctly. If you
do not set such a property, it will automatically take its default value (for example, 0 for int or false
for bool), which will override the value of the property currently stored in the index, even if this was
not your intent. For this reason, it is strongly recommended that you always declare value-typed
properties to be nullable in type T.</para>
<para>The above does not apply if you are using <c cref="T:Microsoft.Azure.Search.Models.Document">Document</c> as type T.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="MergeOrUpload<T>">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.IndexAction<T> MergeOrUpload<T> (T document);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.IndexAction`1<!!T> MergeOrUpload<T>(!!T document) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.IndexAction.MergeOrUpload``1(``0)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function MergeOrUpload(Of T) (document As T) As IndexAction(Of T)" />
<MemberSignature Language="F#" Value="static member MergeOrUpload : 'T -> Microsoft.Azure.Search.Models.IndexAction<'T>" Usage="Microsoft.Azure.Search.Models.IndexAction.MergeOrUpload document" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.IndexAction<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="document" Type="T" />
</Parameters>
<Docs>
<typeparam name="T">
The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index.
</typeparam>
<param name="document">The document to merge or upload.</param>
<summary>
Creates a new IndexAction for uploading a document to the index, or merging it into an existing document
if it already exists in the index.
</summary>
<returns>A new IndexAction.</returns>
<remarks>
<para>If type T contains non-nullable value-typed properties, these properties may not merge correctly. If you
do not set such a property, it will automatically take its default value (for example, 0 for int or false
for bool), which will override the value of the property currently stored in the index, even if this was
not your intent. For this reason, it is strongly recommended that you always declare value-typed
properties to be nullable in type T.</para>
<para>The above does not apply if you are using <c cref="T:Microsoft.Azure.Search.Models.Document">Document</c> as type T.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Upload<T>">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.IndexAction<T> Upload<T> (T document);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.IndexAction`1<!!T> Upload<T>(!!T document) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.IndexAction.Upload``1(``0)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Upload(Of T) (document As T) As IndexAction(Of T)" />
<MemberSignature Language="F#" Value="static member Upload : 'T -> Microsoft.Azure.Search.Models.IndexAction<'T>" Usage="Microsoft.Azure.Search.Models.IndexAction.Upload document" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Data</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.IndexAction<T></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T" />
</TypeParameters>
<Parameters>
<Parameter Name="document" Type="T" />
</Parameters>
<Docs>
<typeparam name="T">
The CLR type that maps to the index schema. Instances of this type can be stored as documents in the index.
</typeparam>
<param name="document">The document to upload.</param>
<summary>
Creates a new IndexAction for uploading a document to the index.
</summary>
<returns>A new IndexAction.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>