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

Class SynonymMap

  • public final class SynonymMap
extends Object
    Represents a synonym map definition.

    • Constructor Detail

      • SynonymMap

        public SynonymMap​(String name)
        Constructor of SynonymMap.
        Parameters:
        name - The name of the synonym map.

      • SynonymMap

        public SynonymMap​(String name,
                  String synonyms)
        Constructor of SynonymMap.
        Parameters:
        name - The name of the synonym map.
        synonyms - A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.

    • Method Detail

      • getName

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

      • getSynonyms

        public String getSynonyms()
        Get the synonyms property: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.
        Returns:
        the synonyms value.

      • setSynonyms

        public SynonymMap setSynonyms​(String synonyms)
        Set the synonyms property: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.
        Parameters:
        synonyms - the synonyms value to set.
        Returns:
        the SynonymMap 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 data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, 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 data 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 SynonymMap 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 data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, 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 data 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 SynonymMap object itself.

      • getETag

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

      • setETag

        public SynonymMap setETag​(String eTag)
        Set the eTag property: The ETag of the synonym map.
        Parameters:
        eTag - the eTag value to set.
        Returns:
        the SynonymMap object itself.

      • createFromFile

        public static SynonymMap createFromFile​(String name,
                                        Path filePath)
        Creates a new instance of SynonymMap with synonyms read from the passed file.
        Parameters:
        name - The name of the synonym map.
        filePath - The path to the file where the formatted synonyms are read.
        Returns:
        A SynonymMap.
        Throws:
        UncheckedIOException - If reading filePath fails.