FieldMapping Class

Definition

Namespace:: Azure.Search.Documents.Indexes.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.1

Package:: Azure.Search.Documents v11.7.0-beta.7

Source:: FieldMapping.cs

Source:: FieldMapping.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Defines a mapping between a field in a data source and a target field in an index.

public class FieldMapping

public class FieldMapping : System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.FieldMapping>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.FieldMapping>

type FieldMapping = class

type FieldMapping = class
    interface IJsonModel<FieldMapping>
    interface IPersistableModel<FieldMapping>

Public Class FieldMapping

Public Class FieldMapping
Implements IJsonModel(Of FieldMapping), IPersistableModel(Of FieldMapping)

Inheritance: Object
FieldMapping

Implements: IJsonModel<FieldMapping> IPersistableModel<FieldMapping> IPersistableModel<T>

Constructors

FieldMapping(String)

Initializes a new instance of FieldMapping.

Properties

MappingFunction	A function to apply to each source field value before indexing.
SourceFieldName	The name of the field in the data source.
TargetFieldName	The name of the target field in the index. Same as the source field name by default.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<FieldMapping>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<FieldMapping>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<FieldMapping>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<FieldMapping>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<FieldMapping>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.

Applies to