-
Notifications
You must be signed in to change notification settings - Fork 256
/
Field.xml
848 lines (848 loc) · 56.3 KB
/
Field.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
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
<Type Name="Field" FullName="Microsoft.Azure.Search.Models.Field">
<TypeSignature Language="C#" Value="public class Field" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Field extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.Models.Field" />
<TypeSignature Language="VB.NET" Value="Public Class Field" />
<TypeSignature Language="F#" Value="type Field = 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 field in an index definition, which describes the name,
data type, and search behavior of a field.
<see href="https://docs.microsoft.com/rest/api/searchservice/Create-Index" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Field (string name, Microsoft.Azure.Search.Models.AnalyzerName analyzerName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, valuetype Microsoft.Azure.Search.Models.AnalyzerName analyzerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.Field.#ctor(System.String,Microsoft.Azure.Search.Models.AnalyzerName)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, analyzerName As AnalyzerName)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.Field : string * Microsoft.Azure.Search.Models.AnalyzerName -> Microsoft.Azure.Search.Models.Field" Usage="new Microsoft.Azure.Search.Models.Field (name, analyzerName)" />
<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="analyzerName" Type="Microsoft.Azure.Search.Models.AnalyzerName" />
</Parameters>
<Docs>
<param name="name">The name of the string field.</param>
<param name="analyzerName">The name of the analyzer to use for the simple field.</param>
<summary>
Initializes a new searchable string Field with required arguments.
</summary>
<remarks>The new field will automatically be searchable and of type Edm.String.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Field (string name, Microsoft.Azure.Search.Models.DataType dataType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, valuetype Microsoft.Azure.Search.Models.DataType dataType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.Field.#ctor(System.String,Microsoft.Azure.Search.Models.DataType)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, dataType As DataType)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.Field : string * Microsoft.Azure.Search.Models.DataType -> Microsoft.Azure.Search.Models.Field" Usage="new Microsoft.Azure.Search.Models.Field (name, dataType)" />
<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="dataType" Type="Microsoft.Azure.Search.Models.DataType" />
</Parameters>
<Docs>
<param name="name">The name of the simple field.</param>
<param name="dataType">The data type of the simple field. Cannot be a complex type.</param>
<summary>
Initializes a new simple Field with required arguments.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">Thrown if <c>dataType</c> is a complex type.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Field (string name, Microsoft.Azure.Search.Models.DataType dataType, Microsoft.Azure.Search.Models.AnalyzerName analyzerName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, valuetype Microsoft.Azure.Search.Models.DataType dataType, valuetype Microsoft.Azure.Search.Models.AnalyzerName analyzerName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.Field.#ctor(System.String,Microsoft.Azure.Search.Models.DataType,Microsoft.Azure.Search.Models.AnalyzerName)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, dataType As DataType, analyzerName As AnalyzerName)" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.Field : string * Microsoft.Azure.Search.Models.DataType * Microsoft.Azure.Search.Models.AnalyzerName -> Microsoft.Azure.Search.Models.Field" Usage="new Microsoft.Azure.Search.Models.Field (name, dataType, analyzerName)" />
<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="dataType" Type="Microsoft.Azure.Search.Models.DataType" />
<Parameter Name="analyzerName" Type="Microsoft.Azure.Search.Models.AnalyzerName" />
</Parameters>
<Docs>
<param name="name">The name of the simple field.</param>
<param name="dataType">The data type of the field. Cannot be a complex type.</param>
<param name="analyzerName">The name of the analyzer to use for the field.</param>
<summary>
Initializes a new searchable simple Field with required arguments.
</summary>
<remarks>The new field will automatically be searchable.</remarks>
<exception cref="T:System.ArgumentException">Thrown if <c>dataType</c> is a complex type.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Field (string name, Microsoft.Azure.Search.Models.DataType dataType, System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field> fields);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string name, valuetype Microsoft.Azure.Search.Models.DataType dataType, class System.Collections.Generic.IList`1<class Microsoft.Azure.Search.Models.Field> fields) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.Field.#ctor(System.String,Microsoft.Azure.Search.Models.DataType,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.Field})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (name As String, dataType As DataType, fields As IList(Of Field))" />
<MemberSignature Language="F#" Value="new Microsoft.Azure.Search.Models.Field : string * Microsoft.Azure.Search.Models.DataType * System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field> -> Microsoft.Azure.Search.Models.Field" Usage="new Microsoft.Azure.Search.Models.Field (name, dataType, fields)" />
<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="dataType" Type="Microsoft.Azure.Search.Models.DataType" />
<Parameter Name="fields" Type="System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field>" />
</Parameters>
<Docs>
<param name="name">The name of the complex field.</param>
<param name="dataType">The data type of the field. Must be a complex type.</param>
<param name="fields">The sub-fields that comprise the complex type. They can be simple or complex fields themselves.</param>
<summary>
Initializes a new complex Field with required arguments.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">Thrown if <c>dataType</c> is not a complex type.</exception>
<exception cref="T:System.ArgumentNullException">Thrown if <c>fields</c> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <c>fields</c> is empty.</exception>
</Docs>
</Member>
<Member MemberName="Analyzer">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.AnalyzerName? Analyzer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.AnalyzerName> Analyzer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.Analyzer" />
<MemberSignature Language="VB.NET" Value="Public Property Analyzer As Nullable(Of AnalyzerName)" />
<MemberSignature Language="F#" Value="member this.Analyzer : Nullable<Microsoft.Azure.Search.Models.AnalyzerName> with get, set" Usage="Microsoft.Azure.Search.Models.Field.Analyzer" />
<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="analyzer")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="analyzer")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Search.Models.AnalyzerName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the language analyzer to use for the
field. This option can be used only with searchable fields and it
can't be set together with either searchAnalyzer or indexAnalyzer.
Once the analyzer is chosen, it cannot be changed for the field.
Must be null for complex fields. Possible values include:
'ar.microsoft', 'ar.lucene', 'hy.lucene', 'bn.microsoft',
'eu.lucene', 'bg.microsoft', 'bg.lucene', 'ca.microsoft',
'ca.lucene', 'zh-Hans.microsoft', 'zh-Hans.lucene',
'zh-Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft',
'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene',
'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene',
'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft',
'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene',
'el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft',
'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene',
'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene',
'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene',
'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft',
'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft',
'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene',
'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene',
'pt-PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft',
'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft',
'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft',
'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene',
'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene',
'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'ur.microsoft',
'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene',
'keyword', 'pattern', 'simple', 'stop', 'whitespace'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Fields">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field> Fields { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<class Microsoft.Azure.Search.Models.Field> Fields" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.Fields" />
<MemberSignature Language="VB.NET" Value="Public Property Fields As IList(Of Field)" />
<MemberSignature Language="F#" Value="member this.Fields : System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field> with get, set" Usage="Microsoft.Azure.Search.Models.Field.Fields" />
<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="fields")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="fields")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of sub-fields if this is a field of type
Edm.ComplexType or Collection(Edm.ComplexType). Must be null or
empty for simple fields.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IndexAnalyzer">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.AnalyzerName? IndexAnalyzer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.AnalyzerName> IndexAnalyzer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.IndexAnalyzer" />
<MemberSignature Language="VB.NET" Value="Public Property IndexAnalyzer As Nullable(Of AnalyzerName)" />
<MemberSignature Language="F#" Value="member this.IndexAnalyzer : Nullable<Microsoft.Azure.Search.Models.AnalyzerName> with get, set" Usage="Microsoft.Azure.Search.Models.Field.IndexAnalyzer" />
<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="indexAnalyzer")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="indexAnalyzer")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Search.Models.AnalyzerName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the analyzer used at indexing time for the
field. This option can be used only with searchable fields. It must
be set together with searchAnalyzer and it cannot be set together
with the analyzer option. Once the analyzer is chosen, it cannot be
changed for the field. Must be null for complex fields. Possible
values include: 'ar.microsoft', 'ar.lucene', 'hy.lucene',
'bn.microsoft', 'eu.lucene', 'bg.microsoft', 'bg.lucene',
'ca.microsoft', 'ca.lucene', 'zh-Hans.microsoft', 'zh-Hans.lucene',
'zh-Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft',
'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene',
'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene',
'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft',
'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene',
'el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft',
'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene',
'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene',
'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene',
'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft',
'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft',
'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene',
'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene',
'pt-PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft',
'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft',
'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft',
'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene',
'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene',
'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'ur.microsoft',
'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene',
'keyword', 'pattern', 'simple', 'stop', 'whitespace'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsFacetable">
<MemberSignature Language="C#" Value="public bool? IsFacetable { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsFacetable" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.IsFacetable" />
<MemberSignature Language="VB.NET" Value="Public Property IsFacetable As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsFacetable : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.Field.IsFacetable" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether to enable the field to be
referenced in facet queries. Typically used in a presentation of
search results that includes hit count by category (for example,
search for digital cameras and see hits by brand, by megapixels, by
price, and so on). This property must be null for complex fields.
Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint)
cannot be facetable. All other simple fields can be facetable.
Default is false for simple fields, and null for complex fields.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsFilterable">
<MemberSignature Language="C#" Value="public bool? IsFilterable { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsFilterable" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.IsFilterable" />
<MemberSignature Language="VB.NET" Value="Public Property IsFilterable As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsFilterable : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.Field.IsFilterable" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether to enable the field to be
referenced in $filter queries. filterable differs from searchable
in how strings are handled. Fields of type Edm.String or
Collection(Edm.String) that are filterable do not undergo
word-breaking, so comparisons are for exact matches only. For
example, if you set such a field f to "sunny day", $filter=f eq
'sunny' will find no matches, but $filter=f eq 'sunny day' will.
This property must be null for complex fields. Default is false for
simple fields and null for complex fields.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsKey">
<MemberSignature Language="C#" Value="public bool? IsKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.IsKey" />
<MemberSignature Language="VB.NET" Value="Public Property IsKey As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsKey : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.Field.IsKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether the field uniquely
identifies documents in the index. Exactly one top-level field in
each index must be chosen as the key field and it must be of type
Edm.String. Key fields can be used to look up documents directly
and update or delete specific documents. Default is false for
simple fields and null for complex fields.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsRetrievable">
<MemberSignature Language="C#" Value="public bool? IsRetrievable { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsRetrievable" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.IsRetrievable" />
<MemberSignature Language="VB.NET" Value="Public Property IsRetrievable As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsRetrievable : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.Field.IsRetrievable" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether the field can be returned
in a search result. You can disable this option if you want to use
a field (for example, margin) as a filter, sorting, or scoring
mechanism but do not want the field to be visible to the end user.
This property must be true for key fields, and it must be null for
complex fields. This property can be changed on existing fields.
Enabling this property does not cause any increase in index storage
requirements. Default is true for simple fields and null for
complex fields.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsSearchable">
<MemberSignature Language="C#" Value="public bool? IsSearchable { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsSearchable" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.IsSearchable" />
<MemberSignature Language="VB.NET" Value="Public Property IsSearchable As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsSearchable : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.Field.IsSearchable" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether the field is full-text
searchable. This means it will undergo analysis such as
word-breaking during indexing. If you set a searchable field to a
value like "sunny day", internally it will be split into the
individual tokens "sunny" and "day". This enables full-text
searches for these terms. This property may be set to true only for
fields of type Edm.String or Collection(Edm.String), and it must be
null for complex fields. Default is false for simple fields and null for
complex fields. Note: searchable fields consume extra space in your
index since Azure Cognitive Search will store an additional tokenized version
of the field value for full-text searches. If you want to save space
in your index and you don't need a field to be included in searches,
set searchable to false.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsSortable">
<MemberSignature Language="C#" Value="public bool? IsSortable { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<bool> IsSortable" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.IsSortable" />
<MemberSignature Language="VB.NET" Value="Public Property IsSortable As Nullable(Of Boolean)" />
<MemberSignature Language="F#" Value="member this.IsSortable : Nullable<bool> with get, set" Usage="Microsoft.Azure.Search.Models.Field.IsSortable" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[Newtonsoft.Json.JsonIgnore]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<System.Boolean></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a value indicating whether to enable the field to be
referenced in $orderby expressions. By default Azure Cognitive Search sorts
results by score, but in many experiences users will want to sort
by fields in the documents. A simple field can be sortable only if
it is single-valued (it has a single value in the scope of the
parent document). Simple collection fields cannot be sortable,
since they are multi-valued. Simple sub-fields of complex
collections are also multi-valued, and therefore cannot be
sortable. This is true whether it's an immediate parent field, or
an ancestor field, that's the complex collection. Complex fields
cannot be sortable and the sortable property must be null for such
fields. The default for sortable is false for simple fields, and
null for complex fields.
</summary>
<value>To be added.</value>
<remarks>To be added.</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.Field.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.Field.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, which must be unique within the
fields collection of the index or parent field.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="New">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.Field New (string name, Microsoft.Azure.Search.Models.DataType dataType, bool isKey = false, bool isRetrievable = true, bool isSearchable = false, bool isFilterable = false, bool isSortable = false, bool isFacetable = false, Microsoft.Azure.Search.Models.AnalyzerName? analyzerName = default, Microsoft.Azure.Search.Models.AnalyzerName? searchAnalyzerName = default, Microsoft.Azure.Search.Models.AnalyzerName? indexAnalyzerName = default, System.Collections.Generic.IList<string> synonymMaps = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.Field New(string name, valuetype Microsoft.Azure.Search.Models.DataType dataType, bool isKey, bool isRetrievable, bool isSearchable, bool isFilterable, bool isSortable, bool isFacetable, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.AnalyzerName> analyzerName, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.AnalyzerName> searchAnalyzerName, valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.AnalyzerName> indexAnalyzerName, class System.Collections.Generic.IList`1<string> synonymMaps) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.Field.New(System.String,Microsoft.Azure.Search.Models.DataType,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Nullable{Microsoft.Azure.Search.Models.AnalyzerName},System.Nullable{Microsoft.Azure.Search.Models.AnalyzerName},System.Nullable{Microsoft.Azure.Search.Models.AnalyzerName},System.Collections.Generic.IList{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function New (name As String, dataType As DataType, Optional isKey As Boolean = false, Optional isRetrievable As Boolean = true, Optional isSearchable As Boolean = false, Optional isFilterable As Boolean = false, Optional isSortable As Boolean = false, Optional isFacetable As Boolean = false, Optional analyzerName As Nullable(Of AnalyzerName) = Nothing, Optional searchAnalyzerName As Nullable(Of AnalyzerName) = Nothing, Optional indexAnalyzerName As Nullable(Of AnalyzerName) = Nothing, Optional synonymMaps As IList(Of String) = Nothing) As Field" />
<MemberSignature Language="F#" Value="static member New : string * Microsoft.Azure.Search.Models.DataType * bool * bool * bool * bool * bool * bool * Nullable<Microsoft.Azure.Search.Models.AnalyzerName> * Nullable<Microsoft.Azure.Search.Models.AnalyzerName> * Nullable<Microsoft.Azure.Search.Models.AnalyzerName> * System.Collections.Generic.IList<string> -> Microsoft.Azure.Search.Models.Field" Usage="Microsoft.Azure.Search.Models.Field.New (name, dataType, isKey, isRetrievable, isSearchable, isFilterable, isSortable, isFacetable, analyzerName, searchAnalyzerName, indexAnalyzerName, synonymMaps)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.Field</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="dataType" Type="Microsoft.Azure.Search.Models.DataType" />
<Parameter Name="isKey" Type="System.Boolean" />
<Parameter Name="isRetrievable" Type="System.Boolean" />
<Parameter Name="isSearchable" Type="System.Boolean" />
<Parameter Name="isFilterable" Type="System.Boolean" />
<Parameter Name="isSortable" Type="System.Boolean" />
<Parameter Name="isFacetable" Type="System.Boolean" />
<Parameter Name="analyzerName" Type="System.Nullable<Microsoft.Azure.Search.Models.AnalyzerName>" />
<Parameter Name="searchAnalyzerName" Type="System.Nullable<Microsoft.Azure.Search.Models.AnalyzerName>" />
<Parameter Name="indexAnalyzerName" Type="System.Nullable<Microsoft.Azure.Search.Models.AnalyzerName>" />
<Parameter Name="synonymMaps" Type="System.Collections.Generic.IList<System.String>" />
</Parameters>
<Docs>
<param name="name">The name of the simple field.</param>
<param name="dataType">The data type of the simple field. Cannot be a complex type.</param>
<param name="isKey">A value indicating whether the field uniquely
identifies documents in the index. Default is false.</param>
<param name="isRetrievable">A value indicating whether the field can
be returned in a search result. Default is true.</param>
<param name="isSearchable">A value indicating whether the field is
full-text search-able. Default is false.</param>
<param name="isFilterable">A value indicating whether to enable the
field to be referenced in $filter queries. Default is false.</param>
<param name="isSortable">A value indicating whether to enable the
field to be referenced in $orderby expressions. Default is false.</param>
<param name="isFacetable">A value indicating whether to enable the
field to be referenced in facet queries. Default is false.</param>
<param name="analyzerName">The name of the language analyzer to use for
the field. Default is null.</param>
<param name="searchAnalyzerName">The name of the analyzer used at
search time for the field. Default is null.</param>
<param name="indexAnalyzerName">The name of the analyzer used at
indexing time for the field. Default is null.</param>
<param name="synonymMaps">A list of synonym map names that
associates synonym maps with the field. Default is null.</param>
<summary>
Creates a new simple Field with required arguments.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">Thrown if <c>dataType</c> is a complex type.</exception>
</Docs>
</Member>
<Member MemberName="NewComplex">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.Field NewComplex (string name, bool isCollection, System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field> fields);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.Field NewComplex(string name, bool isCollection, class System.Collections.Generic.IList`1<class Microsoft.Azure.Search.Models.Field> fields) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.Field.NewComplex(System.String,System.Boolean,System.Collections.Generic.IList{Microsoft.Azure.Search.Models.Field})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function NewComplex (name As String, isCollection As Boolean, fields As IList(Of Field)) As Field" />
<MemberSignature Language="F#" Value="static member NewComplex : string * bool * System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field> -> Microsoft.Azure.Search.Models.Field" Usage="Microsoft.Azure.Search.Models.Field.NewComplex (name, isCollection, fields)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.Field</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="isCollection" Type="System.Boolean" />
<Parameter Name="fields" Type="System.Collections.Generic.IList<Microsoft.Azure.Search.Models.Field>" />
</Parameters>
<Docs>
<param name="name">The name of the complex field.</param>
<param name="isCollection">
<c>true</c> if the field should be of type Collection(Edm.ComplexType); <c>false</c> if it should be
of type Edm.ComplexType.</param>
<param name="fields">The sub-fields that comprise the complex type. They can be simple or complex fields themselves.</param>
<summary>
Creates a new complex Field with required arguments.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <c>fields</c> is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">Thrown if <c>fields</c> is empty.</exception>
</Docs>
</Member>
<Member MemberName="NewSearchableCollection">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.Field NewSearchableCollection (string name, Microsoft.Azure.Search.Models.AnalyzerName analyzerName, bool isKey = false, bool isRetrievable = true, bool isFilterable = false, bool isFacetable = false, System.Collections.Generic.IList<string> synonymMaps = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.Field NewSearchableCollection(string name, valuetype Microsoft.Azure.Search.Models.AnalyzerName analyzerName, bool isKey, bool isRetrievable, bool isFilterable, bool isFacetable, class System.Collections.Generic.IList`1<string> synonymMaps) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.Field.NewSearchableCollection(System.String,Microsoft.Azure.Search.Models.AnalyzerName,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IList{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function NewSearchableCollection (name As String, analyzerName As AnalyzerName, Optional isKey As Boolean = false, Optional isRetrievable As Boolean = true, Optional isFilterable As Boolean = false, Optional isFacetable As Boolean = false, Optional synonymMaps As IList(Of String) = Nothing) As Field" />
<MemberSignature Language="F#" Value="static member NewSearchableCollection : string * Microsoft.Azure.Search.Models.AnalyzerName * bool * bool * bool * bool * System.Collections.Generic.IList<string> -> Microsoft.Azure.Search.Models.Field" Usage="Microsoft.Azure.Search.Models.Field.NewSearchableCollection (name, analyzerName, isKey, isRetrievable, isFilterable, isFacetable, synonymMaps)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.Field</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="analyzerName" Type="Microsoft.Azure.Search.Models.AnalyzerName" />
<Parameter Name="isKey" Type="System.Boolean" />
<Parameter Name="isRetrievable" Type="System.Boolean" />
<Parameter Name="isFilterable" Type="System.Boolean" />
<Parameter Name="isFacetable" Type="System.Boolean" />
<Parameter Name="synonymMaps" Type="System.Collections.Generic.IList<System.String>" />
</Parameters>
<Docs>
<param name="name">The name of the simple field.</param>
<param name="analyzerName">The name of the analyzer to use for the field.</param>
<param name="isKey">A value indicating whether the field uniquely
identifies documents in the index. Default is false.</param>
<param name="isRetrievable">A value indicating whether the field can
be returned in a search result. Default is true.</param>
<param name="isFilterable">A value indicating whether to enable the
field to be referenced in $filter queries. Default is false.</param>
<param name="isFacetable">A value indicating whether to enable the
field to be referenced in facet queries. Default is false.</param>
<param name="synonymMaps">A list of synonym map names that
associates synonym maps with the field. Default is null.</param>
<summary>
Creates a new searchable string collection Field with required arguments.
</summary>
<returns>To be added.</returns>
<remarks>The new field will automatically be searchable and of type Collection(Edm.String).</remarks>
</Docs>
</Member>
<Member MemberName="NewSearchableString">
<MemberSignature Language="C#" Value="public static Microsoft.Azure.Search.Models.Field NewSearchableString (string name, Microsoft.Azure.Search.Models.AnalyzerName analyzerName, bool isKey = false, bool isRetrievable = true, bool isFilterable = false, bool isSortable = false, bool isFacetable = false, System.Collections.Generic.IList<string> synonymMaps = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Search.Models.Field NewSearchableString(string name, valuetype Microsoft.Azure.Search.Models.AnalyzerName analyzerName, bool isKey, bool isRetrievable, bool isFilterable, bool isSortable, bool isFacetable, class System.Collections.Generic.IList`1<string> synonymMaps) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.Models.Field.NewSearchableString(System.String,Microsoft.Azure.Search.Models.AnalyzerName,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.Collections.Generic.IList{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Shared Function NewSearchableString (name As String, analyzerName As AnalyzerName, Optional isKey As Boolean = false, Optional isRetrievable As Boolean = true, Optional isFilterable As Boolean = false, Optional isSortable As Boolean = false, Optional isFacetable As Boolean = false, Optional synonymMaps As IList(Of String) = Nothing) As Field" />
<MemberSignature Language="F#" Value="static member NewSearchableString : string * Microsoft.Azure.Search.Models.AnalyzerName * bool * bool * bool * bool * bool * System.Collections.Generic.IList<string> -> Microsoft.Azure.Search.Models.Field" Usage="Microsoft.Azure.Search.Models.Field.NewSearchableString (name, analyzerName, isKey, isRetrievable, isFilterable, isSortable, isFacetable, synonymMaps)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
<AssemblyVersion>10.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.Field</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="analyzerName" Type="Microsoft.Azure.Search.Models.AnalyzerName" />
<Parameter Name="isKey" Type="System.Boolean" />
<Parameter Name="isRetrievable" Type="System.Boolean" />
<Parameter Name="isFilterable" Type="System.Boolean" />
<Parameter Name="isSortable" Type="System.Boolean" />
<Parameter Name="isFacetable" Type="System.Boolean" />
<Parameter Name="synonymMaps" Type="System.Collections.Generic.IList<System.String>" />
</Parameters>
<Docs>
<param name="name">The name of the string field.</param>
<param name="analyzerName">The name of the analyzer to use for the simple field.</param>
<param name="isKey">A value indicating whether the field uniquely
identifies documents in the index. Default is false.</param>
<param name="isRetrievable">A value indicating whether the field can
be returned in a search result. Default is true.</param>
<param name="isFilterable">A value indicating whether to enable the
field to be referenced in $filter queries. Default is false.</param>
<param name="isSortable">A value indicating whether to enable the
field to be referenced in $orderby expressions. Default is false.</param>
<param name="isFacetable">A value indicating whether to enable the
field to be referenced in facet queries. Default is false.</param>
<param name="synonymMaps">A list of synonym map names that
associates synonym maps with the field. Default is null.</param>
<summary>
Creates a new searchable string Field with required arguments.
</summary>
<returns>To be added.</returns>
<remarks>The new field will automatically be searchable and of type Edm.String.</remarks>
</Docs>
</Member>
<Member MemberName="SearchAnalyzer">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.AnalyzerName? SearchAnalyzer { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype Microsoft.Azure.Search.Models.AnalyzerName> SearchAnalyzer" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.SearchAnalyzer" />
<MemberSignature Language="VB.NET" Value="Public Property SearchAnalyzer As Nullable(Of AnalyzerName)" />
<MemberSignature Language="F#" Value="member this.SearchAnalyzer : Nullable<Microsoft.Azure.Search.Models.AnalyzerName> with get, set" Usage="Microsoft.Azure.Search.Models.Field.SearchAnalyzer" />
<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="searchAnalyzer")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="searchAnalyzer")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Nullable<Microsoft.Azure.Search.Models.AnalyzerName></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the name of the analyzer used at search time for the
field. This option can be used only with searchable fields. It must
be set together with indexAnalyzer and it cannot be set together
with the analyzer option. This analyzer can be updated on an
existing field. Must be null for complex fields. Possible values
include: 'ar.microsoft', 'ar.lucene', 'hy.lucene', 'bn.microsoft',
'eu.lucene', 'bg.microsoft', 'bg.lucene', 'ca.microsoft',
'ca.lucene', 'zh-Hans.microsoft', 'zh-Hans.lucene',
'zh-Hant.microsoft', 'zh-Hant.lucene', 'hr.microsoft',
'cs.microsoft', 'cs.lucene', 'da.microsoft', 'da.lucene',
'nl.microsoft', 'nl.lucene', 'en.microsoft', 'en.lucene',
'et.microsoft', 'fi.microsoft', 'fi.lucene', 'fr.microsoft',
'fr.lucene', 'gl.lucene', 'de.microsoft', 'de.lucene',
'el.microsoft', 'el.lucene', 'gu.microsoft', 'he.microsoft',
'hi.microsoft', 'hi.lucene', 'hu.microsoft', 'hu.lucene',
'is.microsoft', 'id.microsoft', 'id.lucene', 'ga.lucene',
'it.microsoft', 'it.lucene', 'ja.microsoft', 'ja.lucene',
'kn.microsoft', 'ko.microsoft', 'ko.lucene', 'lv.microsoft',
'lv.lucene', 'lt.microsoft', 'ml.microsoft', 'ms.microsoft',
'mr.microsoft', 'nb.microsoft', 'no.lucene', 'fa.lucene',
'pl.microsoft', 'pl.lucene', 'pt-BR.microsoft', 'pt-BR.lucene',
'pt-PT.microsoft', 'pt-PT.lucene', 'pa.microsoft', 'ro.microsoft',
'ro.lucene', 'ru.microsoft', 'ru.lucene', 'sr-cyrillic.microsoft',
'sr-latin.microsoft', 'sk.microsoft', 'sl.microsoft',
'es.microsoft', 'es.lucene', 'sv.microsoft', 'sv.lucene',
'ta.microsoft', 'te.microsoft', 'th.microsoft', 'th.lucene',
'tr.microsoft', 'tr.lucene', 'uk.microsoft', 'ur.microsoft',
'vi.microsoft', 'standard.lucene', 'standardasciifolding.lucene',
'keyword', 'pattern', 'simple', 'stop', 'whitespace'
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SynonymMaps">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IList<string> SynonymMaps { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1<string> SynonymMaps" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.SynonymMaps" />
<MemberSignature Language="VB.NET" Value="Public Property SynonymMaps As IList(Of String)" />
<MemberSignature Language="F#" Value="member this.SynonymMaps : System.Collections.Generic.IList<string> with get, set" Usage="Microsoft.Azure.Search.Models.Field.SynonymMaps" />
<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="synonymMaps")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="synonymMaps")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IList<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a list of the names of synonym maps to associate with
this field. This option can be used only with searchable fields.
Currently only one synonym map per field is supported. 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. Must be null
or an empty collection for complex fields.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Microsoft.Azure.Search.Models.DataType Type { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Azure.Search.Models.DataType Type" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.Models.Field.Type" />
<MemberSignature Language="VB.NET" Value="Public Property Type As DataType" />
<MemberSignature Language="F#" Value="member this.Type : Microsoft.Azure.Search.Models.DataType with get, set" Usage="Microsoft.Azure.Search.Models.Field.Type" />
<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="type")]</AttributeName>
<AttributeName Language="F#">[<Newtonsoft.Json.JsonProperty(PropertyName="type")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Azure.Search.Models.DataType</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the data type of the field. Possible values include:
'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double',
'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint',
'Edm.ComplexType'
</summary>
<value>To be added.</value>
<remarks>To be added.</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.Field.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="field.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>