com.azure.search.models

Class SynonymMap

java.lang.Object

com.azure.search.models.SynonymMap

public final class SynonymMap
extends Object

Represents a synonym map definition.

Constructor Summary

Constructors

Constructor and Description
SynonymMap() Creates an instance of SynonymMap class.

Method Summary

Modifier and Type	Method and Description
EncryptionKey	getEncryptionKey() Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
String	getETag() Get the eTag property: The ETag of the synonym map.
String	getFormat() Get the format property: The format of the synonym map.
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.
SynonymMap	setEncryptionKey(EncryptionKey encryptionKey) Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
SynonymMap	setETag(String eTag) Set the eTag property: The ETag of the synonym map.
SynonymMap	setFormat(String format) Set the format property: The format of the synonym map.
SynonymMap	setName(String name) Set the name property: The name of the synonym map.
SynonymMap	setSynonyms(String synonyms) Set the synonyms property: A series of synonym rules in the specified synonym map format.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SynonymMap

public SynonymMap()

Creates an instance of SynonymMap class.

Method Detail

getName

public String getName()

Get the name property: The name of the synonym map.

Returns:

the name value.

setName

public SynonymMap setName(String name)

Set the name property: The name of the synonym map.

Parameters:

name - the name value to set.

Returns:

the SynonymMap object itself.

getFormat

public String getFormat()

Get the format property: The format of the synonym map. Only the 'solr' format is currently supported.

Returns:

the format value.

setFormat

public SynonymMap setFormat(String format)

Set the format property: The format of the synonym map. Only the 'solr' format is currently supported.

Parameters:

format - the format value to set.

Returns:

the SynonymMap object itself.

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 EncryptionKey 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(EncryptionKey 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.