Class SearchIndexer | Azure SDK for .NET

Represents an indexer.

Inheritance

System.Object

SearchIndexer

Namespace: System.Dynamic.ExpandoObject

Assembly: Azure.Search.Documents.dll

Syntax

public class SearchIndexer

Constructors

SearchIndexer(String, String, String)

Initializes a new instance of SearchIndexer.

Declaration

public SearchIndexer (string name, string dataSourceName, string targetIndexName);

Parameters

System.String name The name of the indexer.

System.String dataSourceName The name of the datasource from which this indexer reads data.

System.String targetIndexName The name of the index to which this indexer writes data.

Exceptions

System.ArgumentNullException name, dataSourceName or targetIndexName is null.

Properties

DataSourceName

The name of the datasource from which this indexer reads data.

Declaration

public string DataSourceName { get; set; }

Property Value

System.String

Description

The description of the indexer.

Declaration

public string Description { get; set; }

Property Value

System.String

EncryptionKey

A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

Declaration

public Azure.Search.Documents.Indexes.Models.SearchResourceEncryptionKey EncryptionKey { get; set; }

Property Value

ETag

Declaration

public Nullable<Azure.ETag> ETag { get; set; }

Property Value

System.Nullable<Azure.ETag>

FieldMappings

Defines mappings between fields in the data source and corresponding target fields in the index.

Declaration

public System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.FieldMapping> FieldMappings { get; }

Property Value

IsDisabled

A value indicating whether the indexer is disabled. Default is false.

Declaration

public Nullable<bool> IsDisabled { get; set; }

Property Value

System.Nullable<System.Boolean>

Name

The name of the indexer.

Declaration

public string Name { get; set; }

Property Value

System.String

OutputFieldMappings

Output field mappings are applied after enrichment and immediately before indexing.

Declaration

public System.Collections.Generic.IList<Azure.Search.Documents.Indexes.Models.FieldMapping> OutputFieldMappings { get; }

Property Value

Parameters

Parameters for indexer execution.

Declaration

public Azure.Search.Documents.Indexes.Models.IndexingParameters Parameters { get; set; }

Property Value

Schedule

The schedule for this indexer.

Declaration

public Azure.Search.Documents.Indexes.Models.IndexingSchedule Schedule { get; set; }

Property Value

SkillsetName

The name of the skillset executing with this indexer.

Declaration

public string SkillsetName { get; set; }

Property Value

System.String

TargetIndexName

The name of the index to which this indexer writes data.

Declaration

public string TargetIndexName { get; set; }

Property Value

System.String