Package org.opensearch.client.opensearch._types.query_dsl

Class SpanGapQuery

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.SpanGapQuery

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, SpanQueryVariant, ToCopyableBuilder<SpanGapQuery.Builder,SpanGapQuery>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class SpanGapQuery
extends Object
implements SpanQueryVariant, PlainJsonSerializable, ToCopyableBuilder<SpanGapQuery.Builder,SpanGapQuery>

Can only be used as a clause in a span_near query.

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	Description
SpanQuery.Kind	_spanQueryKind()	SpanQuery variant kind.
static SpanGapQuery.Builder	builder()
boolean	equals(Object o)
final String	field()	Required - The path to a field or an array of paths.
int	hashCode()
static SpanGapQuery	of(Function<SpanGapQuery.Builder,ObjectBuilder<SpanGapQuery>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupSpanGapQueryDeserializer(ObjectDeserializer<SpanGapQuery.Builder> op)
final int	spanWidth()	Required -
SpanGapQuery.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

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

toJsonString

Methods inherited from interface org.opensearch.client.opensearch._types.query_dsl.SpanQueryVariant

toSpanQuery

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

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<SpanGapQuery> _DESERIALIZER

Json deserializer for SpanGapQuery

Method Details

of

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

_spanQueryKind

public SpanQuery.Kind _spanQueryKind()

SpanQuery variant kind.

Specified by:

_spanQueryKind in interface SpanQueryVariant

field

@Nonnull
public final String field()

Required - The path to a field or an array of paths. Some APIs support wildcards in the path, which allows you to select multiple fields.

spanWidth

public final int spanWidth()

Required -

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

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

toBuilder

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

Returns:

a new builder instance.

builder

@Nonnull
public static SpanGapQuery.Builder builder()

setupSpanGapQueryDeserializer

protected static void setupSpanGapQueryDeserializer(ObjectDeserializer<SpanGapQuery.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object