Language

IndexingParameters Class

Definition

Namespace:
Azure.Search.Documents.Indexes.Models
Assembly:
Azure.Search.Documents.dll
Package:
Azure.Search.Documents v12.0.0
Package:
Azure.Search.Documents v12.1.0-beta.2
Source:
IndexingParameters.cs
Source:
IndexingParameters.cs

Represents parameters for indexer execution.

public class IndexingParameters : System.ClientModel.Primitives.IJsonModel, System.ClientModel.Primitives.IPersistableModel
type IndexingParameters = class
    interface IJsonModel
    interface IPersistableModel
Public Class IndexingParameters
Implements IJsonModel(Of IndexingParameters), IPersistableModel(Of IndexingParameters)
Inheritance
Object
IndexingParameters
Implements
IJsonModel<IndexingParameters> IPersistableModel<IndexingParameters> IPersistableModel

Constructors

Name Description
IndexingParameters()

Initializes a new instance of IndexingParameters.

Properties

Name Description
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

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

Writes the model to the provided Utf8JsonWriter.
IPersistableModel.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions)

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

Writes the model into a BinaryData.

Applies to