-
Notifications
You must be signed in to change notification settings - Fork 256
/
SearchableField.xml
154 lines (154 loc) · 10.5 KB
/
SearchableField.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
<Type Name="SearchableField" FullName="Azure.Search.Documents.Indexes.Models.SearchableField">
<TypeSignature Language="C#" Value="public class SearchableField : Azure.Search.Documents.Indexes.Models.SimpleField" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SearchableField extends Azure.Search.Documents.Indexes.Models.SimpleField" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.Models.SearchableField" />
<TypeSignature Language="VB.NET" Value="Public Class SearchableField
Inherits SimpleField" />
<TypeSignature Language="F#" Value="type SearchableField = class
 inherit SimpleField" />
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.2.0.0</AssemblyVersion>
<AssemblyVersion>11.2.1.0</AssemblyVersion>
<AssemblyVersion>11.3.0.0</AssemblyVersion>
<AssemblyVersion>11.4.0.0</AssemblyVersion>
<AssemblyVersion>11.5.0.0</AssemblyVersion>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Search.Documents.Indexes.Models.SimpleField</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
A <see cref="P:Azure.Search.Documents.Indexes.Models.SearchFieldDataType.String" /> or "Collection(String)" field that can be searched.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SearchableField (string name, bool collection = false);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, bool collection) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.Models.SearchableField.#ctor(System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, Optional collection As Boolean = false)" />
<MemberSignature Language="F#" Value="new Azure.Search.Documents.Indexes.Models.SearchableField : string * bool -> Azure.Search.Documents.Indexes.Models.SearchableField" Usage="new Azure.Search.Documents.Indexes.Models.SearchableField (name, collection)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="collection" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="name">The name of the field, which must be unique within the index or parent field.</param>
<param name="collection">Whether the field is a collection of strings.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.Search.Documents.Indexes.Models.SearchableField" /> class.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="name" /> is an empty string.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="name" /> is null.</exception>
</Docs>
</Member>
<Member MemberName="AnalyzerName">
<MemberSignature Language="C#" Value="public Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName? AnalyzerName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> AnalyzerName" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.SearchableField.AnalyzerName" />
<MemberSignature Language="VB.NET" Value="Public Property AnalyzerName As Nullable(Of LexicalAnalyzerName)" />
<MemberSignature Language="F#" Value="member this.AnalyzerName : Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> with get, set" Usage="Azure.Search.Documents.Indexes.Models.SearchableField.AnalyzerName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the language analyzer. This property cannot be set when either <see cref="P:Azure.Search.Documents.Indexes.Models.SearchableField.SearchAnalyzerName" /> or <see cref="P:Azure.Search.Documents.Indexes.Models.SearchableField.IndexAnalyzerName" /> are set.
Once the analyzer is chosen, it cannot be changed for the field in the index.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IndexAnalyzerName">
<MemberSignature Language="C#" Value="public Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName? IndexAnalyzerName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> IndexAnalyzerName" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.SearchableField.IndexAnalyzerName" />
<MemberSignature Language="VB.NET" Value="Public Property IndexAnalyzerName As Nullable(Of LexicalAnalyzerName)" />
<MemberSignature Language="F#" Value="member this.IndexAnalyzerName : Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> with get, set" Usage="Azure.Search.Documents.Indexes.Models.SearchableField.IndexAnalyzerName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the language analyzer for indexing. This property must be set together with <see cref="P:Azure.Search.Documents.Indexes.Models.SearchableField.SearchAnalyzerName" />, and cannot be set when <see cref="P:Azure.Search.Documents.Indexes.Models.SearchableField.AnalyzerName" /> is set.
This property cannot be set to the name of a language analyzer; use the <see cref="P:Azure.Search.Documents.Indexes.Models.SearchableField.AnalyzerName" /> property instead if you need a language analyzer.
Once the analyzer is chosen, it cannot be changed for the field in the index.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SearchAnalyzerName">
<MemberSignature Language="C#" Value="public Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName? SearchAnalyzerName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> SearchAnalyzerName" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.SearchableField.SearchAnalyzerName" />
<MemberSignature Language="VB.NET" Value="Public Property SearchAnalyzerName As Nullable(Of LexicalAnalyzerName)" />
<MemberSignature Language="F#" Value="member this.SearchAnalyzerName : Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName> with get, set" Usage="Azure.Search.Documents.Indexes.Models.SearchableField.SearchAnalyzerName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<Azure.Search.Documents.Indexes.Models.LexicalAnalyzerName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the language analyzer for searching. This property must be set together with <see cref="P:Azure.Search.Documents.Indexes.Models.SearchableField.IndexAnalyzerName" />, and cannot be set when <see cref="P:Azure.Search.Documents.Indexes.Models.SearchableField.AnalyzerName" /> is set.
This property cannot be set to the name of a language analyzer; use the <see cref="P:Azure.Search.Documents.Indexes.Models.SearchableField.AnalyzerName" /> property instead if you need a language analyzer.
Once the analyzer is chosen, it cannot be changed for the field in the index.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SynonymMapNames">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> SynonymMapNames { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> SynonymMapNames" />
<MemberSignature Language="DocId" Value="P:Azure.Search.Documents.Indexes.Models.SearchableField.SynonymMapNames" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SynonymMapNames As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.SynonymMapNames : System.Collections.Generic.IList<string>" Usage="Azure.Search.Documents.Indexes.Models.SearchableField.SynonymMapNames" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a list of names of synonym maps to associate with this field.
Currently, only one synonym map per field is supported.
</summary>
<value>To be added.</value>
<remarks>
Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map.
This attribute can be changed on existing fields.
</remarks>
</Docs>
</Member>
</Members>
</Type>