TextArrayOptions (AWS SDK for Java

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()

Constructors
Constructor and Description
`TextArrayOptions()`

Method Summary

All Methods Instance Methods Concrete 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
  - setDefaultValue
```
public void setDefaultValue(String defaultValue)
```
    A value to use for the field if the field isn't specified for a document.
    
    Parameters:
    
    defaultValue - A value to use for the field if the field isn't specified for a document.
  - getDefaultValue
```
public String getDefaultValue()
```
    A value to use for the field if the field isn't specified for a document.
    
    Returns:
    
    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.
    
    Parameters:
    
    defaultValue - A value to use for the field if the field isn't specified for a document.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSourceFields
```
public void setSourceFields(String sourceFields)
```
    A list of source fields to map to the field.
    
    Parameters:
    
    sourceFields - A list of source fields to map to the field.
  - getSourceFields
```
public String getSourceFields()
```
    A list of source fields to map to the field.
    
    Returns:
    
    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.
    
    Parameters:
    
    sourceFields - A list of source fields to map to the field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - withReturnEnabled
```
public TextArrayOptions withReturnEnabled(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.
    
    Returns:
    
    Returns a reference to this 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.
  - setHighlightEnabled
```
public void setHighlightEnabled(Boolean highlightEnabled)
```
    Whether highlights can be returned for the field.
    
    Parameters:
    
    highlightEnabled - Whether highlights can be returned for the field.
  - getHighlightEnabled
```
public Boolean getHighlightEnabled()
```
    Whether highlights can be returned for the field.
    
    Returns:
    
    Whether highlights can be returned for the field.
  - withHighlightEnabled
```
public TextArrayOptions withHighlightEnabled(Boolean highlightEnabled)
```
    Whether highlights can be returned for the field.
    
    Parameters:
    
    highlightEnabled - Whether highlights can be returned for the field.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isHighlightEnabled
```
public Boolean isHighlightEnabled()
```
    Whether highlights can be returned for the field.
    
    Returns:
    
    Whether highlights can be returned for the field.
  - setAnalysisScheme
```
public void setAnalysisScheme(String analysisScheme)
```
    The name of an analysis scheme for a text-array field.
    
    Parameters:
    
    analysisScheme - The name of an analysis scheme for a text-array field.
  - getAnalysisScheme
```
public String getAnalysisScheme()
```
    The name of an analysis scheme for a text-array field.
    
    Returns:
    
    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.
    
    Parameters:
    
    analysisScheme - The name of an analysis scheme for a text-array field.
    
    Returns:
    
    Returns a reference to this 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()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public TextArrayOptions clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class TextArrayOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextArrayOptions

Method Detail

setDefaultValue

getDefaultValue

withDefaultValue

setSourceFields

getSourceFields

withSourceFields

setReturnEnabled

getReturnEnabled

withReturnEnabled

isReturnEnabled

setHighlightEnabled

getHighlightEnabled

withHighlightEnabled

isHighlightEnabled

setAnalysisScheme

getAnalysisScheme

withAnalysisScheme

toString

equals

hashCode

clone