Package org.opensearch.client.opensearch._types.analysis

Class CommonGramsTokenFilter

java.lang.Object

org.opensearch.client.opensearch._types.analysis.TokenFilterBase

org.opensearch.client.opensearch._types.analysis.CommonGramsTokenFilter

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, TokenFilterDefinitionVariant, ToCopyableBuilder<CommonGramsTokenFilter.Builder,CommonGramsTokenFilter>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class CommonGramsTokenFilter
extends TokenFilterBase
implements TokenFilterDefinitionVariant, ToCopyableBuilder<CommonGramsTokenFilter.Builder,CommonGramsTokenFilter>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CommonGramsTokenFilter.Builder	Builder for CommonGramsTokenFilter.

Nested classes/interfaces inherited from class org.opensearch.client.opensearch._types.analysis.TokenFilterBase

TokenFilterBase.AbstractBuilder<BuilderT extends TokenFilterBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<CommonGramsTokenFilter>	_DESERIALIZER	Json deserializer for CommonGramsTokenFilter

Method Summary

Modifier and Type	Method	Description
TokenFilterDefinition.Kind	_tokenFilterDefinitionKind()	TokenFilterDefinition variant kind.
static CommonGramsTokenFilter.Builder	builder()
final List<String>	commonWords()	API name: common_words
final String	commonWordsPath()	API name: common_words_path
boolean	equals(Object o)
int	hashCode()
final Boolean	ignoreCase()	API name: ignore_case
static CommonGramsTokenFilter	of(Function<CommonGramsTokenFilter.Builder,ObjectBuilder<CommonGramsTokenFilter>> fn)
final Boolean	queryMode()	API name: query_mode
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupCommonGramsTokenFilterDeserializer(ObjectDeserializer<CommonGramsTokenFilter.Builder> op)
CommonGramsTokenFilter.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class org.opensearch.client.opensearch._types.analysis.TokenFilterBase

serialize, setupTokenFilterBaseDeserializer, version

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.opensearch.client.json.JsonpSerializable

serialize

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Methods inherited from interface org.opensearch.client.opensearch._types.analysis.TokenFilterDefinitionVariant

toTokenFilterDefinition

Field Details

_DESERIALIZER

public static final JsonpDeserializer<CommonGramsTokenFilter> _DESERIALIZER

Json deserializer for CommonGramsTokenFilter

Method Details

of

public static CommonGramsTokenFilter of(Function<CommonGramsTokenFilter.Builder,ObjectBuilder<CommonGramsTokenFilter>> fn)

_tokenFilterDefinitionKind

public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()

TokenFilterDefinition variant kind.

Specified by:

_tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

commonWords

@Nonnull
public final List<String> commonWords()

API name: common_words

commonWordsPath

@Nullable
public final String commonWordsPath()

API name: common_words_path

ignoreCase

@Nullable
public final Boolean ignoreCase()

API name: ignore_case

queryMode

@Nullable
public final Boolean queryMode()

API name: query_mode

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Overrides:

serializeInternal in class TokenFilterBase

toBuilder

@Nonnull
public CommonGramsTokenFilter.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CommonGramsTokenFilter.Builder,CommonGramsTokenFilter>

Returns:

a new builder instance.

builder

@Nonnull
public static CommonGramsTokenFilter.Builder builder()

setupCommonGramsTokenFilterDeserializer

protected static void setupCommonGramsTokenFilterDeserializer(ObjectDeserializer<CommonGramsTokenFilter.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class TokenFilterBase

equals

public boolean equals(Object o)

Overrides:

equals in class TokenFilterBase