IndexingParameters Class

Reference

Definition

Namespace:: Microsoft.Azure.Search.Models

Assembly:: Microsoft.Azure.Search.Service.dll

Package:: Microsoft.Azure.Search.Service v10.1.0

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

type IndexingParameters = class

Public Class IndexingParameters

Inheritance: Object
IndexingParameters

Constructors

IndexingParameters()	Initializes a new instance of the IndexingParameters class.
IndexingParameters(Nullable<Int32>, Nullable<Int32>, Nullable<Int32>, IDictionary<String,Object>)	Initializes a new instance of the IndexingParameters class.

Properties

Base64EncodeKeys	Obsolete. Gets or sets whether indexer will base64-encode all values that are inserted into key field of the target index. This is needed if keys can contain characters that are invalid in keys (such as dot '.'). Default is false.
BatchSize	Gets or sets 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.
Configuration	Gets or sets a dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.
MaxFailedItems	Gets or sets 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	Gets or sets 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.

Extension Methods

DoNotFailOnUnsupportedContentType(IndexingParameters)	Obsolete. Specifies that `BlobExtractionMode.StorageMetadata` blob extraction mode will be automatically used for blobs of unsupported content types. This behavior is enabled by default.
ExcludeFileNameExtensions(IndexingParameters, String[])	Specifies that the indexer will not index blobs with the file name extensions you specify. Each string is a file extensions with a leading dot. For example, ".pdf", ".docx", etc. If you pass the same file extension to this method and IndexFileNameExtensions, blobs with that extension will be excluded from indexing (that is, this method takes precedence). See https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage for details.
IndexFileNameExtensions(IndexingParameters, String[])	Specifies that the indexer will index only the blobs with the file name extensions you specify. Each string is a file extensions with a leading dot. For example, ".pdf", ".docx", etc. If you pass the same file extension to this method and ExcludeFileNameExtensions, blobs with that extension will be excluded from indexing (that is, ExcludeFileNameExtensions takes precedence). See https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage for details.
ParseDelimitedTextFiles(IndexingParameters, String[])	Tells the indexer to assume that all blobs are delimited text files. Currently only comma-separated value (CSV) text files are supported. See https://docs.microsoft.com/azure/search/search-howto-index-csv-blobs for details.
ParseJson(IndexingParameters)	Tells the indexer to assume that all blobs contain JSON, which it will then parse such that each blob's JSON will map to a single document in the search index. See https://docs.microsoft.com/azure/search/search-howto-index-json-blobs/ for details.
ParseJsonArrays(IndexingParameters, String)	Tells the indexer to assume that all blobs contain JSON arrays, which it will then parse such that each JSON object in each array will map to a single document in the search index. See https://docs.microsoft.com/azure/search/search-howto-index-json-blobs for details.
ParseJsonLines(IndexingParameters)	Tells the indexer to assume that all blobs contain new-line separated JSON, which it will then parse such that individual JSON entities in each blob will map to a single document in the search index. See https://docs.microsoft.com/azure/search/search-howto-index-json-blobs/ for details.
ParseText(IndexingParameters)	Tells the indexer to assume that blobs should be parsed as text files in UTF-8 encoding. See https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text
ParseText(IndexingParameters, Encoding)	Tells the indexer to assume that blobs should be parsed as text files in the desired encoding. See https://docs.microsoft.com/azure/search/search-howto-indexing-azure-blob-storage#indexing-plain-text
SetBlobExtractionMode(IndexingParameters, BlobExtractionMode)	Specifies which parts of a blob will be indexed by the blob storage indexer.

Applies to