TextOptions (AWS SDK for Java

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

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class TextOptions
extends Object
implements Serializable, Cloneable
```
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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TextOptions`	`clone()`
`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()`
`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)`
`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)`

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TextOptions
```
public TextOptions()
```
- 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 TextOptions 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.
  - setSourceField
```
public void setSourceField(String sourceField)
```
    Parameters:
    
    sourceField -
  - getSourceField
```
public String getSourceField()
```
    Returns:
  - withSourceField
```
public TextOptions withSourceField(String sourceField)
```
    Parameters:
    
    sourceField -
    
    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 TextOptions 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.
  - 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.
  - 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.
  - withSortEnabled
```
public TextOptions withSortEnabled(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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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 TextOptions 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 field.
    
    Parameters:
    
    analysisScheme - The name of an analysis scheme for a text field.
  - getAnalysisScheme
```
public String getAnalysisScheme()
```
    The name of an analysis scheme for a text field.
    
    Returns:
    
    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.
    
    Parameters:
    
    analysisScheme - The name of an analysis scheme for a text 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 TextOptions clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class TextOptions

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextOptions

Method Detail

setDefaultValue

getDefaultValue

withDefaultValue

setSourceField

getSourceField

withSourceField

setReturnEnabled

getReturnEnabled

withReturnEnabled

isReturnEnabled

setSortEnabled

getSortEnabled

withSortEnabled

isSortEnabled

setHighlightEnabled

getHighlightEnabled

withHighlightEnabled

isHighlightEnabled

setAnalysisScheme

getAnalysisScheme

withAnalysisScheme

toString

equals

hashCode

clone