com.amazonaws.services.cloudsearch.model

Class UpdateSynonymOptionsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cloudsearch.model.UpdateSynonymOptionsRequest

All Implemented Interfaces:

Serializable

public class UpdateSynonymOptionsRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the UpdateSynonymOptions operation.

Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.

See Also:

AmazonCloudSearch.updateSynonymOptions(UpdateSynonymOptionsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
UpdateSynonymOptionsRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDomainName() A string that represents the name of a domain.
String	getSynonyms() Maps terms to their synonyms, serialized as a JSON document.
int	hashCode()
void	setDomainName(String domainName) A string that represents the name of a domain.
void	setSynonyms(String synonyms) Maps terms to their synonyms, serialized as a JSON document.
String	toString() Returns a string representation of this object; useful for testing and debugging.
UpdateSynonymOptionsRequest	withDomainName(String domainName) A string that represents the name of a domain.
UpdateSynonymOptionsRequest	withSynonyms(String synonyms) Maps terms to their synonyms, serialized as a JSON document.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateSynonymOptionsRequest

public UpdateSynonymOptionsRequest()

Method Detail

getDomainName

public String getDomainName()

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Returns:

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

setDomainName

public void setDomainName(String domainName)

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Parameters:

domainName - A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

withDomainName

public UpdateSynonymOptionsRequest withDomainName(String domainName)

A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 3 - 28
Pattern: [a-z][a-z0-9\-]+

Parameters:

domainName - A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed.

Returns:

A reference to this updated object so that method calls can be chained together.

getSynonyms

public String getSynonyms()

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

Returns:

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

setSynonyms

public void setSynonyms(String synonyms)

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

Parameters:

synonyms - Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

withSynonyms

public UpdateSynonymOptionsRequest withSynonyms(String synonyms)

Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

Returns a reference to this object so that method calls can be chained together.

Parameters:

synonyms - Maps terms to their synonyms, serialized as a JSON document. The document has a single object with one property "synonyms" whose value is an object mapping terms to their synonyms. Each synonym is a simple string or an array of strings. The maximum size of a stopwords document is 100 KB. Example: { "synonyms": {"cat": ["feline", "kitten"], "puppy": "dog"} }

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object