Share via

FieldBuilderIgnoreAttribute Class

  • Reference

Definition

Namespace:
Microsoft.Azure.Search
Assembly:
Microsoft.Azure.Search.Service.dll
Package:
Microsoft.Azure.Search.Service v10.1.0

Indicates that the target property should be ignored by FieldBuilder.

[System.AttributeUsage(System.AttributeTargets.Property)]
public class FieldBuilderIgnoreAttribute : Attribute
[<System.AttributeUsage(System.AttributeTargets.Property)>]
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 Field object, but its values still need to be converted to and from JSON. In that case, JsonIgnore 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()

Applies to