SuggestConfig Class

Definition

Namespace:

Azure.Analytics.Purview.DataMap

Assembly:

Azure.Analytics.Purview.DataMap.dll

Package:

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

Source:

SuggestConfig.cs

The payload of suggest request.

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

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

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

Inheritance

Object

SuggestConfig

Implements

IJsonModel<SuggestConfig> IPersistableModel<SuggestConfig> IPersistableModel<T>

Constructors

SuggestConfig()

Initializes a new instance of SuggestConfig.

Properties

Filter	The filter for the search. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
Keywords	The keywords applied to all fields that support suggest operation. It must be at least 1 character, and no more than 100 characters. In the index schema we defined a default suggester which lists all the supported fields and specifies a search mode.
Limit	The number of suggestions we hope to return. The default value is 5. The value must be a number between 1 and 100.

Explicit Interface Implementations

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