QueryConfig Class

Definition

The search query of advanced search request.

public class QueryConfig : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.Purview.DataMap.QueryConfig>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.Purview.DataMap.QueryConfig>
type QueryConfig = class
    interface IJsonModel<QueryConfig>
    interface IPersistableModel<QueryConfig>
Public Class QueryConfig
Implements IJsonModel(Of QueryConfig), IPersistableModel(Of QueryConfig)
Inheritance
QueryConfig
Implements

Constructors

QueryConfig()

Initializes a new instance of QueryConfig.

Properties

ContinuationToken

The token used to get next batch of data. Default 'Null' to get the first batch, and will return new token in each response unless there's no more data.

Facets

The facets for search. See examples for the usage of supported facets.

Filter

The filter for the search. See examples for the usage of supported filters.

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 searchable fields.

Limit

The limit of the number of the search result. default value is 50; maximum value is 1000.

Orderby

The sort order of search results, can specify multiple fields.

To assign an object to the element of 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" }.

TaxonomySetting

The taxonomy setting for search.

Explicit Interface Implementations

IJsonModel<QueryConfig>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<QueryConfig>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<QueryConfig>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<QueryConfig>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<QueryConfig>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to