SearchHighlights Class

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

Azure.Analytics.Purview.DataMap v1.0.0-beta.1

Source:

SearchHighlights.cs

A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the field, attached with emphasis mark, is returned as an element of @search.highlights.

public class SearchHighlights : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.Purview.DataMap.SearchHighlights>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.Purview.DataMap.SearchHighlights>

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

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

Inheritance

Object

SearchHighlights

Implements

IJsonModel<SearchHighlights> IPersistableModel<SearchHighlights> IPersistableModel<T>

Properties

Description	Description.
EntityType	Entity type.
Id	Id.
Name	Name.
QualifiedName	Qualified name.

Explicit Interface Implementations

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