FieldBuilderIgnoreAttribute Class

Definition

Namespace:

Azure.Search.Documents.Indexes

Assembly:

Azure.Search.Documents.dll

Package:

Azure.Search.Documents v11.6.0

Source:

FieldBuilderIgnoreAttribute.cs

Indicates that the target property should be ignored by FieldBuilder.

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)]
public class FieldBuilderIgnoreAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property, AllowMultiple=false, Inherited=true)>]
type FieldBuilderIgnoreAttribute = class
    inherit Attribute

Public Class FieldBuilderIgnoreAttribute
Inherits Attribute

Inheritance

Attribute

FieldBuilderIgnoreAttribute

Attributes

AttributeUsageAttribute

Remarks

This attribute is useful in situations where a property definition doesn't cleanly map to a SearchField object, but its values still need to be converted to and from JSON. In that case, 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.

Constructors

FieldBuilderIgnoreAttribute()