SynonymMap Class

  • Reference
Package:
com.azure.search.documents.indexes.models
Maven Artifact:
com.azure:azure-search-documents:11.6.2
  • java.lang.Object
    • com.azure.search.documents.indexes.models.SynonymMap

Implements

JsonSerializable<SynonymMap>

public final class SynonymMap
implements JsonSerializable<SynonymMap>

Represents a synonym map definition.

Constructor Summary

Constructor Description
SynonymMap()

Creates an instance of SynonymMap class.
SynonymMap(String name)

Constructor of SynonymMap.
SynonymMap(String name, String synonyms)

Constructor of SynonymMap.

Method Summary

Modifier and Type Method and Description
static SynonymMap createFromFile(String name, Path filePath)

Creates a new instance of SynonymMap with synonyms read from the passed file.
static SynonymMap fromJson(JsonReader jsonReader)

Reads an instance of SynonymMap from the JsonReader.
String getETag()

Get the eTag property: The ETag of the synonym map.
SearchResourceEncryptionKey getEncryptionKey()

Get the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
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 setETag(String eTag)

Set the eTag property: The ETag of the synonym map.
SynonymMap setEncryptionKey(SearchResourceEncryptionKey encryptionKey)

Set the encryptionKey property: A description of an encryption key that you create in Azure Key Vault.
SynonymMap setSynonyms(String synonyms)

Set the synonyms property: A series of synonym rules in the specified synonym map format.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

SynonymMap

public SynonymMap()

Creates an instance of SynonymMap class.

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 Details

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.

fromJson

public static SynonymMap fromJson(JsonReader jsonReader)

Reads an instance of SynonymMap from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

 - If an error occurs while reading the SynonymMap.

getETag

public String getETag()

Get the eTag property: The ETag of the synonym map.

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 data when you want full assurance that no one, not even Microsoft, can decrypt your sensitive data. Once you have encrypted your data, 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 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.

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.

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.

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 sensitive data. Once you have encrypted your data, 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 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.

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.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to