com.amazonaws.services.cloudsearch.model

Class TextOptions

java.lang.Object

com.amazonaws.services.cloudsearch.model.TextOptions

All Implemented Interfaces:

Serializable

public class TextOptions
extends Object
implements Serializable

Options that define a text field in the search index.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextOptions()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getDefaultValue() The default value for a text field.
Boolean	getFacetEnabled() Specifies whether facets are enabled for this field.
Boolean	getResultEnabled() Specifies whether values of this field can be returned in search results and used for ranking.
String	getTextProcessor() The text processor to apply to this field.
int	hashCode()
Boolean	isFacetEnabled() Specifies whether facets are enabled for this field.
Boolean	isResultEnabled() Specifies whether values of this field can be returned in search results and used for ranking.
void	setDefaultValue(String defaultValue) The default value for a text field.
void	setFacetEnabled(Boolean facetEnabled) Specifies whether facets are enabled for this field.
void	setResultEnabled(Boolean resultEnabled) Specifies whether values of this field can be returned in search results and used for ranking.
void	setTextProcessor(String textProcessor) The text processor to apply to this field.
String	toString() Returns a string representation of this object; useful for testing and debugging.
TextOptions	withDefaultValue(String defaultValue) The default value for a text field.
TextOptions	withFacetEnabled(Boolean facetEnabled) Specifies whether facets are enabled for this field.
TextOptions	withResultEnabled(Boolean resultEnabled) Specifies whether values of this field can be returned in search results and used for ranking.
TextOptions	withTextProcessor(String textProcessor) The text processor to apply to this field.

Methods inherited from class java.lang.Object

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

Constructor Detail

TextOptions

public TextOptions()

Method Detail

getDefaultValue

public String getDefaultValue()

The default value for a text field. Optional.

Constraints:
Length: 0 - 1024

Returns:

The default value for a text field. Optional.

setDefaultValue

public void setDefaultValue(String defaultValue)

The default value for a text field. Optional.

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - The default value for a text field. Optional.

withDefaultValue

public TextOptions withDefaultValue(String defaultValue)

The default value for a text field. Optional.

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

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - The default value for a text field. Optional.

Returns:

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

isFacetEnabled

public Boolean isFacetEnabled()

Specifies whether facets are enabled for this field. Default: False.

Returns:

Specifies whether facets are enabled for this field. Default: False.

setFacetEnabled

public void setFacetEnabled(Boolean facetEnabled)

Specifies whether facets are enabled for this field. Default: False.

Parameters:

facetEnabled - Specifies whether facets are enabled for this field. Default: False.

withFacetEnabled

public TextOptions withFacetEnabled(Boolean facetEnabled)

Specifies whether facets are enabled for this field. Default: False.

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

Parameters:

facetEnabled - Specifies whether facets are enabled for this field. Default: False.

Returns:

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

getFacetEnabled

public Boolean getFacetEnabled()

Specifies whether facets are enabled for this field. Default: False.

Returns:

Specifies whether facets are enabled for this field. Default: False.

isResultEnabled

public Boolean isResultEnabled()

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

Returns:

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

setResultEnabled

public void setResultEnabled(Boolean resultEnabled)

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

Parameters:

resultEnabled - Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

withResultEnabled

public TextOptions withResultEnabled(Boolean resultEnabled)

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

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

Parameters:

resultEnabled - Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

Returns:

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

getResultEnabled

public Boolean getResultEnabled()

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

Returns:

Specifies whether values of this field can be returned in search results and used for ranking. Default: False.

getTextProcessor

public String getTextProcessor()

The text processor to apply to this field. Optional. Possible values:

• cs_text_no_stemming: turns off stemming for the field.

Default: none

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

Returns:

The text processor to apply to this field. Optional. Possible values:

• cs_text_no_stemming: turns off stemming for the field.

Default: none

setTextProcessor

public void setTextProcessor(String textProcessor)

The text processor to apply to this field. Optional. Possible values:

• cs_text_no_stemming: turns off stemming for the field.

Default: none

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

Parameters:

textProcessor - The text processor to apply to this field. Optional. Possible values:

• cs_text_no_stemming: turns off stemming for the field.

Default: none

withTextProcessor

public TextOptions withTextProcessor(String textProcessor)

The text processor to apply to this field. Optional. Possible values:

• cs_text_no_stemming: turns off stemming for the field.

Default: none

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:

textProcessor - The text processor to apply to this field. Optional. Possible values:

• cs_text_no_stemming: turns off stemming for the field.

Default: none

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