-
Notifications
You must be signed in to change notification settings - Fork 258
/
FieldMappingFunction.xml
406 lines (406 loc) · 25.2 KB
/
FieldMappingFunction.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
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
<Type Name="FieldMappingFunction" FullName="Microsoft.Azure.Search.Models.FieldMappingFunction">
<TypeSignature Language="C#" Value="public class FieldMappingFunction" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FieldMappingFunction extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.FieldMappingFunction" />
<TypeSignature Language="VB.NET" Value="Public Class FieldMappingFunction" />
<TypeSignature Language="F#" Value="type FieldMappingFunction = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Represents a function that transforms a value from a data source before
indexing.
<see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FieldMappingFunction ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.#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 FieldMappingFunction class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FieldMappingFunction (string name, System.Collections.Generic.IDictionary<string,object> parameters = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, class System.Collections.Generic.IDictionary`2<string, object> parameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.#ctor(System.String,System.Collections.Generic.IDictionary{System.String,System.Object})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, Optional parameters As IDictionary(Of String, Object) = Nothing)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.FieldMappingFunction : string * System.Collections.Generic.IDictionary<string, obj> -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="new Microsoft.Azure.Search.Models.FieldMappingFunction (name, parameters)" />
<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="parameters" Type="System.Collections.Generic.IDictionary<System.String,System.Object>" />
</Parameters>
<Docs>
<param name="name">The name of the field mapping function.</param>
<param name="parameters">A dictionary of parameter name/value pairs
to pass to the function. Each value must be of a primitive
type.</param>
<summary>
Initializes a new instance of the FieldMappingFunction class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Base64Decode">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.FieldMappingFunction Base64Decode ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.FieldMappingFunction Base64Decode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Decode" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Base64Decode () As FieldMappingFunction" />
<MemberSignature Language="F#" Value="static member Base64Decode : unit -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Decode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.FieldMappingFunction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a field mapping function that performs Base64 decoding of the input string. The input is assumed
to a URL-safe Base64-encoded string.
</summary>
<returns>A new field mapping function.</returns>
<remarks>
<para>Sample use case: Blob custom metadata values must be ASCII-encoded. You can use Base64 encoding to
represent arbitrary Unicode strings in blob custom metadata. However, to make search meaningful, you can
use this function to turn the encoded data back into "regular" strings when populating your search index.
</para>
<para>
For details on the decoding used, see <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding" />.
Calling this method is the same as calling <c cref="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Decode(System.Boolean)" /> with <c>useHttpServerUtilityUrlTokenDecode</c> set to <c>true</c>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Base64Decode">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.FieldMappingFunction Base64Decode (bool useHttpServerUtilityUrlTokenDecode);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.FieldMappingFunction Base64Decode(bool useHttpServerUtilityUrlTokenDecode) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Decode(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Base64Decode (useHttpServerUtilityUrlTokenDecode As Boolean) As FieldMappingFunction" />
<MemberSignature Language="F#" Value="static member Base64Decode : bool -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Decode useHttpServerUtilityUrlTokenDecode" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.FieldMappingFunction</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="useHttpServerUtilityUrlTokenDecode" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="useHttpServerUtilityUrlTokenDecode">Determines how Base64 decoding is performed. See <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding" /> for details.</param>
<summary>
Creates a field mapping function that performs Base64 decoding of the input string. The input is assumed
to a URL-safe Base64-encoded string.
</summary>
<returns>A new field mapping function.</returns>
<remarks>
Sample use case: Blob custom metadata values must be ASCII-encoded. You can use Base64 encoding to
represent arbitrary Unicode strings in blob custom metadata. However, to make search meaningful, you can
use this function to turn the encoded data back into "regular" strings when populating your search index.
</remarks>
</Docs>
</Member>
<Member MemberName="Base64Encode">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.FieldMappingFunction Base64Encode ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.FieldMappingFunction Base64Encode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Encode" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Base64Encode () As FieldMappingFunction" />
<MemberSignature Language="F#" Value="static member Base64Encode : unit -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Encode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.FieldMappingFunction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a field mapping function that performs URL-safe Base64 encoding of the input string. Assumes that
the input is UTF-8 encoded.
</summary>
<returns>A new field mapping function.</returns>
<remarks>
<para>Sample use case: Only URL-safe characters can appear in a search document key (because customers
must be able to address the document using the Lookup API, for example). If your data contains URL-unsafe
characters and you want to use it to populate a key field in your search index, use this function.
</para>
<para>
For details on the encoding used, see <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding" />.
Calling this method is the same as calling <c cref="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Encode(System.Boolean)" /> with <c>useHttpServerUtilityUrlTokenEncode</c> set to <c>true</c>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Base64Encode">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.FieldMappingFunction Base64Encode (bool useHttpServerUtilityUrlTokenEncode);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.FieldMappingFunction Base64Encode(bool useHttpServerUtilityUrlTokenEncode) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Encode(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function Base64Encode (useHttpServerUtilityUrlTokenEncode As Boolean) As FieldMappingFunction" />
<MemberSignature Language="F#" Value="static member Base64Encode : bool -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.Base64Encode useHttpServerUtilityUrlTokenEncode" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.FieldMappingFunction</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="useHttpServerUtilityUrlTokenEncode" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="useHttpServerUtilityUrlTokenEncode">Determines how Base64 encoding is performed. See <see href="https://docs.microsoft.com/azure/search/search-indexer-field-mappings#details-of-base64-encoding-and-decoding" /> for details.</param>
<summary>
Creates a field mapping function that performs URL-safe Base64 encoding of the input string. Assumes that
the input is UTF-8 encoded.
</summary>
<returns>A new field mapping function.</returns>
<remarks>
Sample use case: Only URL-safe characters can appear in a search document key (because customers
must be able to address the document using the Lookup API, for example). If your data contains URL-unsafe
characters and you want to use it to populate a key field in your search index, use this function.
</remarks>
</Docs>
</Member>
<Member MemberName="ExtractTokenAtPosition">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.FieldMappingFunction ExtractTokenAtPosition (string delimiter, int position);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.FieldMappingFunction ExtractTokenAtPosition(string delimiter, int32 position) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.ExtractTokenAtPosition(System.String,System.Int32)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function ExtractTokenAtPosition (delimiter As String, position As Integer) As FieldMappingFunction" />
<MemberSignature Language="F#" Value="static member ExtractTokenAtPosition : string * int -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.ExtractTokenAtPosition (delimiter, position)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.FieldMappingFunction</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="delimiter" Type="System.String" />
<Parameter Name="position" Type="System.Int32" />
</Parameters>
<Docs>
<param name="delimiter">A string to use as the separator when splitting the input string.</param>
<param name="position">An integer zero-based position of the token to pick after the input string is split.</param>
<summary>
Creates a field mapping function that splits a string field using the specified delimiter, and picks the
token at the specified position in the resulting split.
</summary>
<returns>A new field mapping function.</returns>
<remarks>
<para>
For example, if the input is Jane Doe, the delimiter is " " (space) and the position is 0, the result is
Jane; if the position is 1, the result is Doe. If the position refers to a token that doesn't exist, an
error will be returned.
</para>
<para>
Sample use case: Your data source contains a PersonName field, and you want to index it as two separate
FirstName and LastName fields. You can use this function to split the input using the space character as
the delimiter.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="JsonArrayToStringCollection">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.FieldMappingFunction JsonArrayToStringCollection ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.FieldMappingFunction JsonArrayToStringCollection() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.JsonArrayToStringCollection" />
<MemberSignature Language="VB.NET" Value="Public Shared Function JsonArrayToStringCollection () As FieldMappingFunction" />
<MemberSignature Language="F#" Value="static member JsonArrayToStringCollection : unit -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.JsonArrayToStringCollection " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.FieldMappingFunction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a field mapping function that transforms a string formatted as a JSON array of strings into a string array that can be used to
populate a Collection(Edm.String) field in the index.
</summary>
<returns>A new field mapping function.</returns>
<remarks>
<para>
For example, if the input string is ["red", "white", "blue"], then the target field of type Collection(Edm.String) will be populated
with the three values red, white and blue. For input values that cannot be parsed as JSON string arrays, an error will be returned.
</para>
<para>
Sample use case: Azure SQL database doesn't have a built-in data type that naturally maps to Collection(Edm.String) fields in Azure
Search. To populate string collection fields, format your source data as a JSON string array and use this function.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.FieldMappingFunction.Name" />
<MemberSignature Language="VB.NET" Value="Public Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.Name" />
<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="name")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="name")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the field mapping function.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parameters">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IDictionary<string,object> Parameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IDictionary`2<string, object> Parameters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.FieldMappingFunction.Parameters" />
<MemberSignature Language="VB.NET" Value="Public Property Parameters As IDictionary(Of String, Object)" />
<MemberSignature Language="F#" Value="member this.Parameters : System.Collections.Generic.IDictionary<string, obj> with get, set" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.Parameters" />
<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="parameters")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="parameters")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IDictionary<System.String,System.Object></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a dictionary of parameter name/value pairs to pass to
the function. Each value must be of a primitive type.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UrlDecode">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.FieldMappingFunction UrlDecode ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.FieldMappingFunction UrlDecode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.UrlDecode" />
<MemberSignature Language="VB.NET" Value="Public Shared Function UrlDecode () As FieldMappingFunction" />
<MemberSignature Language="F#" Value="static member UrlDecode : unit -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.UrlDecode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.FieldMappingFunction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a field mapping function that performs url decoding of the input string. It assumes that the input
string has been url decoded with UTF-8 encoding format.
</summary>
<returns>A new field mapping function</returns>
<remarks>
Sample use case: Some clients that try to update blob custom metadata (which need to be ASCII-encoded) might
choose to URL encode the data. To ingest that custom metadata and make search meaningful, the URL decode
field mapping function can be used while populating the search index.
</remarks>
</Docs>
</Member>
<Member MemberName="UrlEncode">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.FieldMappingFunction UrlEncode ();" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.FieldMappingFunction UrlEncode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.UrlEncode" />
<MemberSignature Language="VB.NET" Value="Public Shared Function UrlEncode () As FieldMappingFunction" />
<MemberSignature Language="F#" Value="static member UrlEncode : unit -> Microsoft.Azure.Search.Models.FieldMappingFunction" Usage="Microsoft.Azure.Search.Models.FieldMappingFunction.UrlEncode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.FieldMappingFunction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates a field mapping function that performs a simple URL-safe encoding of the input string,
using UTF-8 encoding format.
</summary>
<returns>A new field mapping function</returns>
<remarks>
Sample use case: This field mapping function can be used as an alternative to Base64Encode if only the URL
unsafe characters of a key field need to be safely converted, while other characters can remain as-is.
</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public virtual void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.FieldMappingFunction.Validate" />
<MemberSignature Language="VB.NET" Value="Public Overridable Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit
override this.Validate : unit -> unit" Usage="fieldMappingFunction.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>