SearchIndexer Class

Package:

com.azure.search.documents.indexes.models

Maven Artifact:

com.azure:azure-search-documents:11.7.3

• java.lang.Object
• • com.azure.search.documents.indexes.models.SearchIndexer

Implements

JsonSerializable<SearchIndexer>

public final class SearchIndexer
implements JsonSerializable<SearchIndexer>

Represents an indexer.

Constructor Summary

Constructor	Description
SearchIndexer(String name)	Creates an instance of SearchIndexer class.
SearchIndexer(String name, String dataSourceName, String targetIndexName)	Constructor of SearchIndexer.

Method Summary

Modifier and Type	Method and Description
static SearchIndexer	fromJson(JsonReader jsonReader) Reads an instance of SearchIndexer from the JsonReader.
String	getDataSourceName() Get the dataSourceName property: The name of the datasource from which this indexer reads data.
String	getDescription() Get the description property: The description of the indexer.
String	getETag() Get the eTag property: The ETag of the indexer.
SearchResourceEncryptionKey	getEncryptionKey() Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
List<FieldMapping>	getFieldMappings() Get the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index.
String	getName() Get the name property: The name of the indexer.
List<FieldMapping>	getOutputFieldMappings() Get the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing.
IndexingParameters	getParameters() Get the parameters property: Parameters for indexer execution.
IndexingSchedule	getSchedule() Get the schedule property: The schedule for this indexer.
String	getSkillsetName() Get the skillsetName property: The name of the skillset executing with this indexer.
String	getTargetIndexName() Get the targetIndexName property: The name of the index to which this indexer writes data.
Boolean	isDisabled() Get the isDisabled property: A value indicating whether the indexer is disabled.
SearchIndexer	setDataSourceName(String dataSourceName) Set the dataSourceName property: The name of the datasource from which this indexer reads data.
SearchIndexer	setDescription(String description) Set the description property: The description of the indexer.
SearchIndexer	setETag(String eTag) Set the eTag property: The ETag of the indexer.
SearchIndexer	setEncryptionKey(SearchResourceEncryptionKey encryptionKey) Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
SearchIndexer	setFieldMappings(FieldMapping[] fieldMappings) Set the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index.
SearchIndexer	setFieldMappings(List<FieldMapping> fieldMappings) Set the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index.
SearchIndexer	setIsDisabled(Boolean isDisabled) Set the isDisabled property: A value indicating whether the indexer is disabled.
SearchIndexer	setOutputFieldMappings(FieldMapping[] outputFieldMappings) Set the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing.
SearchIndexer	setOutputFieldMappings(List<FieldMapping> outputFieldMappings) Set the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing.
SearchIndexer	setParameters(IndexingParameters parameters) Set the parameters property: Parameters for indexer execution.
SearchIndexer	setSchedule(IndexingSchedule schedule) Set the schedule property: The schedule for this indexer.
SearchIndexer	setSkillsetName(String skillsetName) Set the skillsetName property: The name of the skillset executing with this indexer.
SearchIndexer	setTargetIndexName(String targetIndexName) Set the targetIndexName property: The name of the index to which this indexer writes data.
JsonWriter	toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SearchIndexer

public SearchIndexer(String name)

Creates an instance of SearchIndexer class.

Parameters:

name - the name value to set.

SearchIndexer

public SearchIndexer(String name, String dataSourceName, String targetIndexName)

Constructor of SearchIndexer.

Parameters:

name - The name of the indexer.

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

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

Method Details

fromJson

public static SearchIndexer fromJson(JsonReader jsonReader)

Reads an instance of SearchIndexer from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of SearchIndexer if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

getDataSourceName

public String getDataSourceName()

Get the dataSourceName property: The name of the datasource from which this indexer reads data.

Returns:

the dataSourceName value.

getDescription

public String getDescription()

Get the description property: The description of the indexer.

Returns:

the description value.

getETag

public String getETag()

Get the eTag property: The ETag of the indexer.

Returns:

the eTag value.

getEncryptionKey

public SearchResourceEncryptionKey getEncryptionKey()

Get the encryptionKey property: 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.

Returns:

the encryptionKey value.

getFieldMappings

public List getFieldMappings()

Get the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index.

Returns:

the fieldMappings value.

getName

public String getName()

Get the name property: The name of the indexer.

Returns:

the name value.

getOutputFieldMappings

public List getOutputFieldMappings()

Get the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing.

Returns:

the outputFieldMappings value.

getParameters

public IndexingParameters getParameters()

Get the parameters property: Parameters for indexer execution.

Returns:

the parameters value.

getSchedule

public IndexingSchedule getSchedule()

Get the schedule property: The schedule for this indexer.

Returns:

the schedule value.

getSkillsetName

public String getSkillsetName()

Get the skillsetName property: The name of the skillset executing with this indexer.

Returns:

the skillsetName value.

getTargetIndexName

public String getTargetIndexName()

Get the targetIndexName property: The name of the index to which this indexer writes data.

Returns:

the targetIndexName value.

isDisabled

public Boolean isDisabled()

Get the isDisabled property: A value indicating whether the indexer is disabled. Default is false.

Returns:

the isDisabled value.

setDataSourceName

public SearchIndexer setDataSourceName(String dataSourceName)

Set the dataSourceName property: The name of the datasource from which this indexer reads data.

Parameters:

dataSourceName - the dataSourceName value to set.

Returns:

the SearchIndexer object itself.

setDescription

public SearchIndexer setDescription(String description)

Set the description property: The description of the indexer.

Parameters:

description - the description value to set.

Returns:

the SearchIndexer object itself.

setETag

public SearchIndexer setETag(String eTag)

Set the eTag property: The ETag of the indexer.

Parameters:

eTag - the eTag value to set.

Returns:

the SearchIndexer object itself.

setEncryptionKey

public SearchIndexer setEncryptionKey(SearchResourceEncryptionKey encryptionKey)

Set the encryptionKey property: 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.

Parameters:

encryptionKey - the encryptionKey value to set.

Returns:

the SearchIndexer object itself.

setFieldMappings

public SearchIndexer setFieldMappings(FieldMapping[] fieldMappings)

Set the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index.

Parameters:

fieldMappings - the fieldMappings value to set.

Returns:

the SearchIndexer object itself.

setFieldMappings

public SearchIndexer setFieldMappings(List fieldMappings)

Set the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index.

Parameters:

fieldMappings - the fieldMappings value to set.

Returns:

the SearchIndexer object itself.

setIsDisabled

public SearchIndexer setIsDisabled(Boolean isDisabled)

Set the isDisabled property: A value indicating whether the indexer is disabled. Default is false.

Parameters:

isDisabled - the isDisabled value to set.

Returns:

the SearchIndexer object itself.

setOutputFieldMappings

public SearchIndexer setOutputFieldMappings(FieldMapping[] outputFieldMappings)

Set the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing.

Parameters:

outputFieldMappings - the outputFieldMappings value to set.

Returns:

the SearchIndexer object itself.

setOutputFieldMappings

public SearchIndexer setOutputFieldMappings(List outputFieldMappings)

Set the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing.

Parameters:

outputFieldMappings - the outputFieldMappings value to set.

Returns:

the SearchIndexer object itself.

setParameters

public SearchIndexer setParameters(IndexingParameters parameters)

Set the parameters property: Parameters for indexer execution.

Parameters:

parameters - the parameters value to set.

Returns:

the SearchIndexer object itself.

setSchedule

public SearchIndexer setSchedule(IndexingSchedule schedule)

Set the schedule property: The schedule for this indexer.

Parameters:

schedule - the schedule value to set.

Returns:

the SearchIndexer object itself.

setSkillsetName

public SearchIndexer setSkillsetName(String skillsetName)

Set the skillsetName property: The name of the skillset executing with this indexer.

Parameters:

skillsetName - the skillsetName value to set.

Returns:

the SearchIndexer object itself.

setTargetIndexName

public SearchIndexer setTargetIndexName(String targetIndexName)

Set the targetIndexName property: The name of the index to which this indexer writes data.

Parameters:

targetIndexName - the targetIndexName value to set.

Returns:

the SearchIndexer object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException