com.amazonaws.services.cloudsearchv2.model

Class TextArrayOptions

java.lang.Object

com.amazonaws.services.cloudsearchv2.model.TextArrayOptions

All Implemented Interfaces:

Serializable, Cloneable

public class TextArrayOptions
extends Object
implements Serializable, Cloneable

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TextArrayOptions()

Method Summary

Methods

Modifier and Type	Method and Description
TextArrayOptions	clone()
boolean	equals(Object obj)
String	getAnalysisScheme() The name of an analysis scheme for a text-array field.
String	getDefaultValue() A value to use for the field if the field isn't specified for a document.
Boolean	getHighlightEnabled() Whether highlights can be returned for the field.
Boolean	getReturnEnabled() Whether the contents of the field can be returned in the search results.
String	getSourceFields() A list of source fields to map to the field.
int	hashCode()
Boolean	isHighlightEnabled() Whether highlights can be returned for the field.
Boolean	isReturnEnabled() Whether the contents of the field can be returned in the search results.
void	setAnalysisScheme(String analysisScheme) The name of an analysis scheme for a text-array field.
void	setDefaultValue(String defaultValue) A value to use for the field if the field isn't specified for a document.
void	setHighlightEnabled(Boolean highlightEnabled) Whether highlights can be returned for the field.
void	setReturnEnabled(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.
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.
TextArrayOptions	withAnalysisScheme(String analysisScheme) The name of an analysis scheme for a text-array field.
TextArrayOptions	withDefaultValue(String defaultValue) A value to use for the field if the field isn't specified for a document.
TextArrayOptions	withHighlightEnabled(Boolean highlightEnabled) Whether highlights can be returned for the field.
TextArrayOptions	withReturnEnabled(Boolean returnEnabled) Whether the contents of the field can be returned in the search results.
TextArrayOptions	withSourceFields(String sourceFields) A list of source fields to map to the field.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

TextArrayOptions

public TextArrayOptions()

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 TextArrayOptions 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 TextArrayOptions 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.

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 TextArrayOptions 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.

isHighlightEnabled

public Boolean isHighlightEnabled()

Whether highlights can be returned for the field.

Returns:

Whether highlights can be returned for the field.

setHighlightEnabled

public void setHighlightEnabled(Boolean highlightEnabled)

Whether highlights can be returned for the field.

Parameters:

highlightEnabled - Whether highlights can be returned for the field.

withHighlightEnabled

public TextArrayOptions withHighlightEnabled(Boolean highlightEnabled)

Whether highlights can be returned for the field.

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

Parameters:

highlightEnabled - Whether highlights can be returned for the field.

Returns:

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

getHighlightEnabled

public Boolean getHighlightEnabled()

Whether highlights can be returned for the field.

Returns:

Whether highlights can be returned for the field.

getAnalysisScheme

public String getAnalysisScheme()

The name of an analysis scheme for a text-array field.

Constraints:
Pattern: [\S]+

Returns:

The name of an analysis scheme for a text-array field.

setAnalysisScheme

public void setAnalysisScheme(String analysisScheme)

The name of an analysis scheme for a text-array field.

Constraints:
Pattern: [\S]+

Parameters:

analysisScheme - The name of an analysis scheme for a text-array field.

withAnalysisScheme

public TextArrayOptions withAnalysisScheme(String analysisScheme)

The name of an analysis scheme for a text-array field.

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

Constraints:
Pattern: [\S]+

Parameters:

analysisScheme - The name of an analysis scheme for a text-array field.

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

clone

public TextArrayOptions clone()

Overrides:

clone in class Object