TextOptions (AWS SDK for Java 1.8.9 API)

java.lang.Object
- com.amazonaws.services.cloudsearchv2.model.TextOptions

All Implemented Interfaces:

Serializable
```
public class TextOptions
extends Object
implements Serializable
```
Options for text field. Present if IndexFieldType specifies the field is of type text . A text field is always searchable. All options are enabled by default.

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description

TextOptions()

Constructors
Constructor and Description
`TextOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`String`	`getAnalysisScheme()` The name of an analysis scheme for a `text` 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.
`Boolean`	`getSortEnabled()` Whether the field can be used to sort the search results.
`String`	`getSourceField()` A string that represents the name of an index 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.
`Boolean`	`isSortEnabled()` Whether the field can be used to sort the search results.
`void`	`setAnalysisScheme(String analysisScheme)` The name of an analysis scheme for a `text` 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`	`setSortEnabled(Boolean sortEnabled)` Whether the field can be used to sort the search results.
`void`	`setSourceField(String sourceField)` A string that represents the name of an index field.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`TextOptions`	`withAnalysisScheme(String analysisScheme)` The name of an analysis scheme for a `text` field.
`TextOptions`	`withDefaultValue(String defaultValue)` A value to use for the field if the field isn't specified for a document.
`TextOptions`	`withHighlightEnabled(Boolean highlightEnabled)` Whether highlights can be returned for the field.
`TextOptions`	`withReturnEnabled(Boolean returnEnabled)` Whether the contents of the field can be returned in the search results.
`TextOptions`	`withSortEnabled(Boolean sortEnabled)` Whether the field can be used to sort the search results.
`TextOptions`	`withSourceField(String sourceField)` A string that represents the name of an index 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()
```
    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 TextOptions 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.
  - getSourceField
```
public String getSourceField()
```
    A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
    Constraints:
    Length: 1 - 64
    Pattern: [a-z][a-z0-9_]*
    
    Returns:
    A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
  - setSourceField
```
public void setSourceField(String sourceField)
```
    A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
    Constraints:
    Length: 1 - 64
    Pattern: [a-z][a-z0-9_]*
    
    Parameters:
    sourceField - A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
  - withSourceField
```
public TextOptions withSourceField(String sourceField)
```
    A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
    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:
    sourceField - A string that represents the name of an index field. Field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). The name "score" is reserved and cannot be used as a field name. To reference a document's ID, you can use the name _id.
    
    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 TextOptions 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.
  - isSortEnabled
```
public Boolean isSortEnabled()
```
    Whether the field can be used to sort the search results.
    
    Returns:
    Whether the field can be used to sort the search results.
  - setSortEnabled
```
public void setSortEnabled(Boolean sortEnabled)
```
    Whether the field can be used to sort the search results.
    
    Parameters:
    sortEnabled - Whether the field can be used to sort the search results.
  - withSortEnabled
```
public TextOptions withSortEnabled(Boolean sortEnabled)
```
    Whether the field can be used to sort the search results.
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    sortEnabled - Whether the field can be used to sort the search results.
    
    Returns:
    A reference to this updated object so that method calls can be chained together.
  - getSortEnabled
```
public Boolean getSortEnabled()
```
    Whether the field can be used to sort the search results.
    
    Returns:
    Whether the field can be used to sort 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 TextOptions 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 field.
    Constraints:
    Pattern: [\S]+
    
    Returns:
    The name of an analysis scheme for a text field.
  - setAnalysisScheme
```
public void setAnalysisScheme(String analysisScheme)
```
    The name of an analysis scheme for a text field.
    Constraints:
    Pattern: [\S]+
    
    Parameters:
    analysisScheme - The name of an analysis scheme for a text field.
  - withAnalysisScheme
```
public TextOptions withAnalysisScheme(String analysisScheme)
```
    The name of an analysis scheme for a text 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 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

Class TextOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextOptions

Method Detail

getDefaultValue

setDefaultValue

withDefaultValue

getSourceField

setSourceField

withSourceField

isReturnEnabled

setReturnEnabled

withReturnEnabled

getReturnEnabled

isSortEnabled

setSortEnabled

withSortEnabled

getSortEnabled

isHighlightEnabled

setHighlightEnabled

withHighlightEnabled

getHighlightEnabled

getAnalysisScheme

setAnalysisScheme

withAnalysisScheme

toString

hashCode

equals