com.amazonaws.services.cloudsearchv2.model
Class LiteralArrayOptions

java.lang.Object
  com.amazonaws.services.cloudsearchv2.model.LiteralArrayOptions

All Implemented Interfaces:

Serializable

public class LiteralArrayOptions
extends Object
implements Serializable

Options for a field that contains an array of literal strings. Present if IndexFieldType specifies the field is of type literal-array . All options are enabled by default.

See Also:

Serialized Form

Constructor Summary

LiteralArrayOptions()

Method Summary

boolean	equals(Object obj)
String	getDefaultValue() A value to use for the field if the field isn't specified for a document.
Boolean	getFacetEnabled() Whether facet information can be returned for the field.
Boolean	getReturnEnabled() Whether the contents of the field can be returned in the search results.
Boolean	getSearchEnabled() Whether the contents of the field are searchable.
String	getSourceFields() A list of source fields to map to the field.
int	hashCode()
Boolean	isFacetEnabled() Whether facet information can be returned for the field.
Boolean	isReturnEnabled() Whether the contents of the field can be returned in the search results.
Boolean	isSearchEnabled() Whether the contents of the field are searchable.
void	setDefaultValue(String defaultValue) A value to use for the field if the field isn't specified for a document.
void	setFacetEnabled(Boolean facetEnabled) Whether facet information can be returned for the field.
void	setReturnEnabled(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.
void	setSearchEnabled(Boolean searchEnabled) Whether the contents of the field are searchable.
void	setSourceFields(String sourceFields) A list of source fields to map to the field.
String	toString() Returns a string representation of this object; useful for testing and debugging.
LiteralArrayOptions	withDefaultValue(String defaultValue) A value to use for the field if the field isn't specified for a document.
LiteralArrayOptions	withFacetEnabled(Boolean facetEnabled) Whether facet information can be returned for the field.
LiteralArrayOptions	withReturnEnabled(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.
LiteralArrayOptions	withSearchEnabled(Boolean searchEnabled) Whether the contents of the field are searchable.
LiteralArrayOptions	withSourceFields(String sourceFields) A list of source fields to map to the field.

Methods inherited from class java.lang.Object

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

Constructor Detail

LiteralArrayOptions

public LiteralArrayOptions()

Method Detail

getDefaultValue

public String getDefaultValue()

A value to use for the field if the field isn't specified for a document.

Constraints:
Length: 0 - 1024

Returns:

A value to use for the field if the field isn't specified for a document.

setDefaultValue

public void setDefaultValue(String defaultValue)

A value to use for the field if the field isn't specified for a document.

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - A value to use for the field if the field isn't specified for a document.

withDefaultValue

public LiteralArrayOptions withDefaultValue(String defaultValue)

A value to use for the field if the field isn't specified for a document.

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

Constraints:
Length: 0 - 1024

Parameters:

defaultValue - A value to use for the field if the field isn't specified for a document.

Returns:

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

getSourceFields

public String getSourceFields()

A list of source fields to map to the field.

Constraints:
Pattern: \s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*

Returns:

A list of source fields to map to the field.

setSourceFields

public void setSourceFields(String sourceFields)

A list of source fields to map to the field.

Constraints:
Pattern: \s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*

Parameters:

sourceFields - A list of source fields to map to the field.

withSourceFields

public LiteralArrayOptions withSourceFields(String sourceFields)

A list of source fields to map to the field.

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

Constraints:
Pattern: \s*[a-z][a-z0-9_]*\s*(,\s*[a-z][a-z0-9_]*\s*)*

Parameters:

sourceFields - A list of source fields to map to the field.

Returns:

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

isFacetEnabled

public Boolean isFacetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

setFacetEnabled

public void setFacetEnabled(Boolean facetEnabled)

Whether facet information can be returned for the field.

Parameters:

facetEnabled - Whether facet information can be returned for the field.

withFacetEnabled

public LiteralArrayOptions withFacetEnabled(Boolean facetEnabled)

Whether facet information can be returned for the field.

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

Parameters:

facetEnabled - Whether facet information can be returned for the field.

Returns:

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

getFacetEnabled

public Boolean getFacetEnabled()

Whether facet information can be returned for the field.

Returns:

Whether facet information can be returned for the field.

isSearchEnabled

public Boolean isSearchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

setSearchEnabled

public void setSearchEnabled(Boolean searchEnabled)

Whether the contents of the field are searchable.

Parameters:

searchEnabled - Whether the contents of the field are searchable.

withSearchEnabled

public LiteralArrayOptions withSearchEnabled(Boolean searchEnabled)

Whether the contents of the field are searchable.

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

Parameters:

searchEnabled - Whether the contents of the field are searchable.

Returns:

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

getSearchEnabled

public Boolean getSearchEnabled()

Whether the contents of the field are searchable.

Returns:

Whether the contents of the field are searchable.

isReturnEnabled

public Boolean isReturnEnabled()

Whether the contents of the field can be returned in the search results.

Returns:

Whether the contents of the field can be returned in the search results.

setReturnEnabled

public void setReturnEnabled(Boolean returnEnabled)

Whether the contents of the field can be returned in the search results.

Parameters:

returnEnabled - Whether the contents of the field can be returned in the search results.

withReturnEnabled

public LiteralArrayOptions withReturnEnabled(Boolean returnEnabled)

Whether the contents of the field can be returned in the search results.

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

Parameters:

returnEnabled - Whether the contents of the field can be returned in the search results.

Returns:

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

getReturnEnabled

public Boolean getReturnEnabled()

Whether the contents of the field can be returned in the search results.

Returns:

Whether the contents of the field can be returned in the search results.

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