com.amazonaws.services.cloudsearchv2.model

Class Suggester

java.lang.Object

com.amazonaws.services.cloudsearchv2.model.Suggester

All Implemented Interfaces:

Serializable

public class Suggester
extends Object
implements Serializable

Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: FuzzyMatching , SortExpression .

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
Suggester()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
DocumentSuggesterOptions	getDocumentSuggesterOptions() Options for a search suggester.
String	getSuggesterName() A string that represents the name of an index field.
int	hashCode()
void	setDocumentSuggesterOptions(DocumentSuggesterOptions documentSuggesterOptions) Options for a search suggester.
void	setSuggesterName(String suggesterName) A string that represents the name of an index field.
String	toString() Returns a string representation of this object; useful for testing and debugging.
Suggester	withDocumentSuggesterOptions(DocumentSuggesterOptions documentSuggesterOptions) Options for a search suggester.
Suggester	withSuggesterName(String suggesterName) A string that represents the name of an index field.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Suggester

public Suggester()

Method Detail

getSuggesterName

public String getSuggesterName()

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Returns:

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

setSuggesterName

public void setSuggesterName(String suggesterName)

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

suggesterName - A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

withSuggesterName

public Suggester withSuggesterName(String suggesterName)

A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

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

Constraints:
Length: 1 - 64
Pattern: [a-z][a-z0-9_]*

Parameters:

suggesterName - A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.

Returns:

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

getDocumentSuggesterOptions

public DocumentSuggesterOptions getDocumentSuggesterOptions()

Options for a search suggester.

Returns:

Options for a search suggester.

setDocumentSuggesterOptions

public void setDocumentSuggesterOptions(DocumentSuggesterOptions documentSuggesterOptions)

Options for a search suggester.

Parameters:

documentSuggesterOptions - Options for a search suggester.

withDocumentSuggesterOptions

public Suggester withDocumentSuggesterOptions(DocumentSuggesterOptions documentSuggesterOptions)

Options for a search suggester.

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

Parameters:

documentSuggesterOptions - Options for a search suggester.

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