-
Notifications
You must be signed in to change notification settings - Fork 255
/
PatternReplaceCharFilter.xml
162 lines (162 loc) · 8.55 KB
/
PatternReplaceCharFilter.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
<Type Name="PatternReplaceCharFilter" FullName="Microsoft.Azure.Search.Models.PatternReplaceCharFilter">
<TypeSignature Language="C#" Value="public class PatternReplaceCharFilter : Microsoft.Azure.Search.Models.CharFilter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PatternReplaceCharFilter extends Microsoft.Azure.Search.Models.CharFilter" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.PatternReplaceCharFilter" />
<TypeSignature Language="VB.NET" Value="Public Class PatternReplaceCharFilter
Inherits CharFilter" />
<TypeSignature Language="F#" Value="type PatternReplaceCharFilter = class
 inherit CharFilter" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Azure.Search.Models.CharFilter</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.PatternReplaceCharFilter")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.PatternReplaceCharFilter")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A character filter that replaces characters in the input string. It
uses a regular expression to identify character sequences to preserve
and a replacement pattern to identify characters to replace. For
example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and
replacement "$1#$2", the result would be "aa#bb aa#bb". This character
filter is implemented using Apache Lucene.
<see href="https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PatternReplaceCharFilter ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the PatternReplaceCharFilter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public PatternReplaceCharFilter (string name, string pattern, string replacement);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, string pattern, string replacement) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.#ctor(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, pattern As String, replacement As String)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.PatternReplaceCharFilter : string * string * string -> Microsoft.Azure.Search.Models.PatternReplaceCharFilter" Usage="new Microsoft.Azure.Search.Models.PatternReplaceCharFilter (name, pattern, replacement)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="pattern" Type="System.String" />
<Parameter Name="replacement" Type="System.String" />
</Parameters>
<Docs>
<param name="name">The name of the char filter. It must only
contain letters, digits, spaces, dashes or underscores, can only
start and end with alphanumeric characters, and is limited to 128
characters.</param>
<param name="pattern">A regular expression pattern.</param>
<param name="replacement">The replacement text.</param>
<summary>
Initializes a new instance of the PatternReplaceCharFilter class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Pattern">
<MemberSignature Language="C#" Value="public string Pattern { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Pattern" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.Pattern" />
<MemberSignature Language="VB.NET" Value="Public Property Pattern As String" />
<MemberSignature Language="F#" Value="member this.Pattern : string with get, set" Usage="Microsoft.Azure.Search.Models.PatternReplaceCharFilter.Pattern" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="pattern")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="pattern")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a regular expression pattern.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Replacement">
<MemberSignature Language="C#" Value="public string Replacement { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Replacement" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.Replacement" />
<MemberSignature Language="VB.NET" Value="Public Property Replacement As String" />
<MemberSignature Language="F#" Value="member this.Replacement : string with get, set" Usage="Microsoft.Azure.Search.Models.PatternReplaceCharFilter.Replacement" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonProperty(PropertyName="replacement")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="replacement")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the replacement text.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public override void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.PatternReplaceCharFilter.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub Validate ()" />
<MemberSignature Language="F#" Value="override this.Validate : unit -> unit" Usage="patternReplaceCharFilter.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.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>