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

Class ShingleTokenFilter

java.lang.Object

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

org.opensearch.client.opensearch._types.analysis.ShingleTokenFilter

All Implemented Interfaces:

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

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

Nested Class Summary

Nested Classes

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

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<ShingleTokenFilter>	_DESERIALIZER	Json deserializer for ShingleTokenFilter

Method Summary

Modifier and Type	Method	Description
TokenFilterDefinition.Kind	_tokenFilterDefinitionKind()	TokenFilterDefinition variant kind.
static ShingleTokenFilter.Builder	builder()
boolean	equals(Object o)
final String	fillerToken()	API name: filler_token
int	hashCode()
final Integer	maxShingleSize()	API name: max_shingle_size
final Integer	minShingleSize()	API name: min_shingle_size
static ShingleTokenFilter	of(Function<ShingleTokenFilter.Builder,ObjectBuilder<ShingleTokenFilter>> fn)
final Boolean	outputUnigrams()	API name: output_unigrams
final Boolean	outputUnigramsIfNoShingles()	API name: output_unigrams_if_no_shingles
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupShingleTokenFilterDeserializer(ObjectDeserializer<ShingleTokenFilter.Builder> op)
ShingleTokenFilter.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.
final String	tokenSeparator()	API name: token_separator

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<ShingleTokenFilter> _DESERIALIZER

Json deserializer for ShingleTokenFilter

Method Details

of

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

_tokenFilterDefinitionKind

public TokenFilterDefinition.Kind _tokenFilterDefinitionKind()

TokenFilterDefinition variant kind.

Specified by:

_tokenFilterDefinitionKind in interface TokenFilterDefinitionVariant

fillerToken

@Nullable
public final String fillerToken()

API name: filler_token

maxShingleSize

@Nullable
public final Integer maxShingleSize()

API name: max_shingle_size

minShingleSize

@Nullable
public final Integer minShingleSize()

API name: min_shingle_size

outputUnigrams

@Nullable
public final Boolean outputUnigrams()

API name: output_unigrams

outputUnigramsIfNoShingles

@Nullable
public final Boolean outputUnigramsIfNoShingles()

API name: output_unigrams_if_no_shingles

tokenSeparator

@Nullable
public final String tokenSeparator()

API name: token_separator

serializeInternal

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

Overrides:

serializeInternal in class TokenFilterBase

toBuilder

@Nonnull
public ShingleTokenFilter.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<ShingleTokenFilter.Builder,ShingleTokenFilter>

Returns:

a new builder instance.

builder

@Nonnull
public static ShingleTokenFilter.Builder builder()

setupShingleTokenFilterDeserializer

protected static void setupShingleTokenFilterDeserializer(ObjectDeserializer<ShingleTokenFilter.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class TokenFilterBase

equals

public boolean equals(Object o)

Overrides:

equals in class TokenFilterBase