Package com.azure.search.documents.indexes.models

Class SearchIndexer

  • public final class SearchIndexer
extends Object
    Represents an indexer.

    • Constructor Detail

      • SearchIndexer

        public SearchIndexer​(String name)
        Constructor of SearchIndexer.
        Parameters:
        name - The name of the indexer.

      • 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 Detail

      • getName

        public String getName()
        Get the name property: The name of the indexer.
        Returns:
        the name value.

      • getDescription

        public String getDescription()
        Get the description property: The description of the indexer.
        Returns:
        the description value.

      • 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.

      • getDataSourceName

        public String getDataSourceName()
        Get the dataSourceName property: The name of the datasource from which this indexer reads data.
        Returns:
        the dataSourceName 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.
        Returns:
        the SearchIndexer object itself.

      • getSkillsetName

        public String getSkillsetName()
        Get the skillsetName property: The name of the skillset executing with this indexer.
        Returns:
        the skillsetName value.

      • 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.

      • getTargetIndexName

        public String getTargetIndexName()
        Get the targetIndexName property: The name of the index to which this indexer writes data.
        Returns:
        the targetIndexName value.

      • 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.
        Returns:
        the SearchIndexer object itself.

      • getSchedule

        public IndexingSchedule getSchedule()
        Get the schedule property: The schedule for this indexer.
        Returns:
        the schedule value.

      • 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.

      • getParameters

        public IndexingParameters getParameters()
        Get the parameters property: Parameters for indexer execution.
        Returns:
        the parameters value.

      • 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.

      • getFieldMappings

        public List<FieldMapping> getFieldMappings()
        Get the fieldMappings property: Defines mappings between fields in the data source and corresponding target fields in the index.
        Returns:
        the fieldMappings value.

      • 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<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.

      • getOutputFieldMappings

        public List<FieldMapping> getOutputFieldMappings()
        Get the outputFieldMappings property: Output field mappings are applied after enrichment and immediately before indexing.
        Returns:
        the outputFieldMappings value.

      • 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<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.

      • isDisabled

        public Boolean isDisabled()
        Get the isDisabled property: A value indicating whether the indexer is disabled. Default is false.
        Returns:
        the isDisabled value.

      • 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.

      • getETag

        public String getETag()
        Get the eTag property: The ETag of the indexer.
        Returns:
        the eTag value.

      • 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.

      • 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 in Azure Cognitive Search. Once you have encrypted your indexer definition, it will always remain encrypted. Azure Cognitive Search 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.

      • 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 in Azure Cognitive Search. Once you have encrypted your indexer definition, it will always remain encrypted. Azure Cognitive Search 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.

      • getCache

        public SearchIndexerCache getCache()
        Get the cache property: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time.
        Returns:
        the cache value.

      • setCache

        public SearchIndexer setCache​(SearchIndexerCache cache)
        Set the cache property: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time.
        Parameters:
        cache - the cache value to set.
        Returns:
        the SearchIndexer object itself.