java.lang.Object
- software.amazon.awssdk.services.cloudsearch.model.AnalysisOptions

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AnalysisOptions.Builder,AnalysisOptions>
```
@Generated("software.amazon.awssdk:codegen")
public final class AnalysisOptions
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AnalysisOptions.Builder,AnalysisOptions>
```
Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AnalysisOptions.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AlgorithmicStemming`	`algorithmicStemming()`	The level of algorithmic stemming to perform: `none`, `minimal`, `light`, or `full`.
`String`	`algorithmicStemmingAsString()`	The level of algorithmic stemming to perform: `none`, `minimal`, `light`, or `full`.
`static AnalysisOptions.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`japaneseTokenizationDictionary()`	A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AnalysisOptions.Builder>`	`serializableBuilderClass()`
`String`	`stemmingDictionary()`	A JSON object that contains a collection of string:value pairs that each map a term to its stem.
`String`	`stopwords()`	A JSON array of terms to ignore during indexing and searching.
`String`	`synonyms()`	A JSON object that defines synonym groups and aliases.
`AnalysisOptions.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - synonyms
```
public final String synonyms()
```
    A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
    
    Returns:
    
    A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see Synonyms in the Amazon CloudSearch Developer Guide.
  - stopwords
```
public final String stopwords()
```
    A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"] . The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
    
    Returns:
    
    A JSON array of terms to ignore during indexing and searching. For example, ["a", "an", "the", "of"]. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported.
  - stemmingDictionary
```
public final String stemmingDictionary()
```
    A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
    
    Returns:
    
    A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, {"term1": "stem1", "term2": "stem2", "term3": "stem3"}. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.
  - japaneseTokenizationDictionary
```
public final String japaneseTokenizationDictionary()
```
    A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
    
    Returns:
    
    A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.
  - algorithmicStemming
```
public final AlgorithmicStemming algorithmicStemming()
```
    The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
    
    If the service returns an enum value that is not available in the current SDK version, algorithmicStemming will return AlgorithmicStemming.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from algorithmicStemmingAsString().
    
    Returns:
    
    The level of algorithmic stemming to perform: none, minimal, light , or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
    
    See Also:
    
    AlgorithmicStemming
  - algorithmicStemmingAsString
```
public final String algorithmicStemmingAsString()
```
    The level of algorithmic stemming to perform: none, minimal, light, or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
    
    If the service returns an enum value that is not available in the current SDK version, algorithmicStemming will return AlgorithmicStemming.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from algorithmicStemmingAsString().
    
    Returns:
    
    The level of algorithmic stemming to perform: none, minimal, light , or full. The available levels vary depending on the language. For more information, see Language Specific Text Processing Settings in the Amazon CloudSearch Developer Guide
    
    See Also:
    
    AlgorithmicStemming
  - toBuilder
```
public AnalysisOptions.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AnalysisOptions.Builder,AnalysisOptions>
  - builder
```
public static AnalysisOptions.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AnalysisOptions.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AnalysisOptions

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

synonyms

stopwords

stemmingDictionary

japaneseTokenizationDictionary

algorithmicStemming

algorithmicStemmingAsString

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields