-
Notifications
You must be signed in to change notification settings - Fork 256
/
FieldBuilderIgnoreAttribute.xml
58 lines (58 loc) · 3.18 KB
/
FieldBuilderIgnoreAttribute.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
<Type Name="FieldBuilderIgnoreAttribute" FullName="Azure.Search.Documents.Indexes.FieldBuilderIgnoreAttribute">
<TypeSignature Language="C#" Value="public class FieldBuilderIgnoreAttribute : Attribute" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FieldBuilderIgnoreAttribute extends System.Attribute" />
<TypeSignature Language="DocId" Value="T:Azure.Search.Documents.Indexes.FieldBuilderIgnoreAttribute" />
<TypeSignature Language="VB.NET" Value="Public Class FieldBuilderIgnoreAttribute
Inherits Attribute" />
<TypeSignature Language="F#" Value="type FieldBuilderIgnoreAttribute = class
 inherit Attribute" />
<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>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)]</AttributeName>
<AttributeName Language="F#">[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Indicates that the target property should be ignored by <see cref="T:Azure.Search.Documents.Indexes.FieldBuilder" />.
</summary>
<remarks>
This attribute is useful in situations where a property definition doesn't cleanly map to a <see cref="T:Azure.Search.Documents.Indexes.Models.SearchField" />
object, but its values still need to be converted to and from JSON. In that case,
<see cref="T:System.Text.Json.Serialization.JsonIgnoreAttribute" /> can't be used since it would disable JSON conversion.
An example of a scenario where this is useful is when mapping between a string field in Azure Cognitive Search and an enum
property.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FieldBuilderIgnoreAttribute ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.Search.Documents.Indexes.FieldBuilderIgnoreAttribute.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.Search.Documents</AssemblyName>
<AssemblyVersion>11.5.1.0</AssemblyVersion>
<AssemblyVersion>11.6.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>