SynonymMap Class
- java.lang.Object
- com.azure.search.documents.indexes.models.SynonymMap
public final class SynonymMap
Represents a synonym map definition.
Constructor Summary
| Constructor | Description |
|---|---|
| SynonymMap(String name) |
Constructor of SynonymMap. |
| SynonymMap(String name, String synonyms) |
Constructor of SynonymMap. |
Method Summary
| Modifier and Type | Method and Description |
|---|---|
|
static
Synonym |
createFromFile(String name, Path filePath)
Creates a new instance of Synonym |
| String |
getETag()
Get the e |
|
Search |
getEncryptionKey()
Get the encryption |
| String |
getName()
Get the name property: The name of the synonym map. |
| String |
getSynonyms()
Get the synonyms property: A series of synonym rules in the specified synonym map format. |
|
Synonym |
setETag(String eTag)
Set the e |
|
Synonym |
setEncryptionKey(SearchResourceEncryptionKey encryptionKey)
Set the encryption |
|
Synonym |
setSynonyms(String synonyms)
Set the synonyms property: A series of synonym rules in the specified synonym map format. |
Methods inherited from java.lang.Object
Constructor Details
SynonymMap
public SynonymMap(String name)
Constructor of SynonymMap.
Parameters:
SynonymMap
public SynonymMap(String name, String synonyms)
Constructor of SynonymMap.
Parameters:
Method Details
createFromFile
public static SynonymMap createFromFile(String name, Path filePath)
Creates a new instance of SynonymMap with synonyms read from the passed file.
Parameters:
Returns:
getETag
public String getETag()
Get the eTag property: The ETag of the synonym map.
Returns:
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:
getName
public String getName()
Get the name property: The name of the synonym map.
Returns:
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:
setETag
public SynonymMap setETag(String eTag)
Set the eTag property: The ETag of the synonym map.
Parameters:
Returns:
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:
Returns:
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:
Returns: