IndexingParameters 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.6

Source:: IndexingParameters.cs

Source:: IndexingParameters.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.

Represents parameters for indexer execution.

public class IndexingParameters

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

type IndexingParameters = class

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

Public Class IndexingParameters

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

Inheritance: Object
IndexingParameters

Implements: IJsonModel<IndexingParameters> IPersistableModel<IndexingParameters> IPersistableModel<T>

Constructors

IndexingParameters()

Initializes a new instance of IndexingParameters.

Properties

BatchSize	The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type.
IndexingParametersConfiguration	Indexer-specific configuration properties. Each value must be of a primitive type.
MaxFailedItems	The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0.
MaxFailedItemsPerBatch	The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to