com.amazonaws.services.cloudsearch.model
Class LiteralOptions

java.lang.Object
  com.amazonaws.services.cloudsearch.model.LiteralOptions

All Implemented Interfaces:

Serializable

public class LiteralOptions
extends Object
implements Serializable

Options that define a literal field in the search index.

See Also:

Serialized Form

Constructor Summary

LiteralOptions()

Method Summary

boolean	equals(Object obj)
String	getDefaultValue() The default value for a literal 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.
Boolean	getSearchEnabled() Specifies whether search is enabled for 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.
Boolean	isSearchEnabled() Specifies whether search is enabled for this field.
void	setDefaultValue(String defaultValue) The default value for a literal 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	setSearchEnabled(Boolean searchEnabled) Specifies whether search is enabled for this field.
String	toString() Returns a string representation of this object; useful for testing and debugging.
LiteralOptions	withDefaultValue(String defaultValue) The default value for a literal field.
LiteralOptions	withFacetEnabled(Boolean facetEnabled) Specifies whether facets are enabled for this field.
LiteralOptions	withResultEnabled(Boolean resultEnabled) Specifies whether values of this field can be returned in search results and used for ranking.
LiteralOptions	withSearchEnabled(Boolean searchEnabled) Specifies whether search is enabled for this field.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LiteralOptions

public LiteralOptions()

Method Detail

getDefaultValue

public String getDefaultValue()

The default value for a literal field.

Constraints:
Length: 0 - 1024

Returns:

The default value for a literal field.

setDefaultValue

public void setDefaultValue(String defaultValue)

The default value for a literal field.

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - The default value for a literal field.

withDefaultValue

public LiteralOptions withDefaultValue(String defaultValue)

The default value for a literal field.

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 literal field.

Returns:

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

isSearchEnabled

public Boolean isSearchEnabled()

Specifies whether search is enabled for this field.

Returns:

Specifies whether search is enabled for this field.

setSearchEnabled

public void setSearchEnabled(Boolean searchEnabled)

Specifies whether search is enabled for this field.

Parameters:

searchEnabled - Specifies whether search is enabled for this field.

withSearchEnabled

public LiteralOptions withSearchEnabled(Boolean searchEnabled)

Specifies whether search is enabled for this field.

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

Parameters:

searchEnabled - Specifies whether search is enabled for this field.

Returns:

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

getSearchEnabled

public Boolean getSearchEnabled()

Specifies whether search is enabled for this field.

Returns:

Specifies whether search is enabled for this field.

isFacetEnabled

public Boolean isFacetEnabled()

Specifies whether facets are enabled for this field.

Returns:

Specifies whether facets are enabled for this field.

setFacetEnabled

public void setFacetEnabled(Boolean facetEnabled)

Specifies whether facets are enabled for this field.

Parameters:

facetEnabled - Specifies whether facets are enabled for this field.

withFacetEnabled

public LiteralOptions withFacetEnabled(Boolean facetEnabled)

Specifies whether facets are enabled for this field.

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

Parameters:

facetEnabled - Specifies whether facets are enabled for this field.

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.

Returns:

Specifies whether facets are enabled for this field.

isResultEnabled

public Boolean isResultEnabled()

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

Returns:

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

setResultEnabled

public void setResultEnabled(Boolean resultEnabled)

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

Parameters:

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

withResultEnabled

public LiteralOptions withResultEnabled(Boolean resultEnabled)

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

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.

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.

Returns:

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

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