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

Class SpanQuery.Builder

java.lang.Object

org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder<SpanQuery.Builder>

org.opensearch.client.opensearch._types.query_dsl.SpanQuery.Builder

All Implemented Interfaces:

ObjectBuilder<SpanQuery>

Enclosing class:

SpanQuery

public static class SpanQuery.Builder
extends QueryBase.AbstractBuilder<SpanQuery.Builder>
implements ObjectBuilder<SpanQuery>

Builder for SpanQuery.

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.client.util.ObjectBuilder

ObjectBuilder.Constant<V>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SpanQuery	build()	Builds a SpanQuery.
SpanQuery.Builder	fieldMaskingSpan(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: field_masking_span
SpanQuery.Builder	fieldMaskingSpan(NamedQuery<jakarta.json.JsonValue> value)	API name: field_masking_span
protected SpanQuery.Builder	self()
SpanQuery.Builder	spanContaining(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: span_containing
SpanQuery.Builder	spanContaining(NamedQuery<jakarta.json.JsonValue> value)	API name: span_containing
SpanQuery.Builder	spanFirst(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: span_first
SpanQuery.Builder	spanFirst(NamedQuery<jakarta.json.JsonValue> value)	API name: span_first
SpanQuery.Builder	spanGap(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: span_gap
SpanQuery.Builder	spanGap(NamedQuery<jakarta.json.JsonValue> value)	API name: span_gap
SpanQuery.Builder	spanMulti(java.util.function.Function<SpanMultiTermQuery.Builder,ObjectBuilder<SpanMultiTermQuery>> fn)	API name: span_multi
SpanQuery.Builder	spanMulti(SpanMultiTermQuery value)	API name: span_multi
SpanQuery.Builder	spanNear(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: span_near
SpanQuery.Builder	spanNear(NamedQuery<jakarta.json.JsonValue> value)	API name: span_near
SpanQuery.Builder	spanNot(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: span_not
SpanQuery.Builder	spanNot(NamedQuery<jakarta.json.JsonValue> value)	API name: span_not
SpanQuery.Builder	spanOr(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: span_or
SpanQuery.Builder	spanOr(NamedQuery<jakarta.json.JsonValue> value)	API name: span_or
SpanQuery.Builder	spanTerm(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: span_term
SpanQuery.Builder	spanTerm(NamedQuery<jakarta.json.JsonValue> value)	API name: span_term
SpanQuery.Builder	spanWithin(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)	API name: span_within
SpanQuery.Builder	spanWithin(NamedQuery<jakarta.json.JsonValue> value)	API name: span_within

Methods inherited from class org.opensearch.client.opensearch._types.query_dsl.QueryBase.AbstractBuilder

boost, name

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

spanContaining

public SpanQuery.Builder spanContaining(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: span_containing

spanContaining

public SpanQuery.Builder spanContaining(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: span_containing

fieldMaskingSpan

public SpanQuery.Builder fieldMaskingSpan(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: field_masking_span

fieldMaskingSpan

public SpanQuery.Builder fieldMaskingSpan(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: field_masking_span

spanFirst

public SpanQuery.Builder spanFirst(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: span_first

spanFirst

public SpanQuery.Builder spanFirst(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: span_first

spanGap

public SpanQuery.Builder spanGap(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: span_gap

spanGap

public SpanQuery.Builder spanGap(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: span_gap

spanMulti

public SpanQuery.Builder spanMulti(@Nullable SpanMultiTermQuery value)

API name: span_multi

spanMulti

public SpanQuery.Builder spanMulti(java.util.function.Function<SpanMultiTermQuery.Builder,ObjectBuilder<SpanMultiTermQuery>> fn)

API name: span_multi

spanNear

public SpanQuery.Builder spanNear(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: span_near

spanNear

public SpanQuery.Builder spanNear(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: span_near

spanNot

public SpanQuery.Builder spanNot(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: span_not

spanNot

public SpanQuery.Builder spanNot(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: span_not

spanOr

public SpanQuery.Builder spanOr(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: span_or

spanOr

public SpanQuery.Builder spanOr(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: span_or

spanTerm

public SpanQuery.Builder spanTerm(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: span_term

spanTerm

public SpanQuery.Builder spanTerm(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: span_term

spanWithin

public SpanQuery.Builder spanWithin(@Nullable NamedQuery<jakarta.json.JsonValue> value)

API name: span_within

spanWithin

public SpanQuery.Builder spanWithin(java.util.function.Function<NamedQuery.Builder<jakarta.json.JsonValue>,ObjectBuilder<NamedQuery<jakarta.json.JsonValue>>> fn)

API name: span_within

self

protected SpanQuery.Builder self()

Specified by:

self in class QueryBase.AbstractBuilder<SpanQuery.Builder>

build

public SpanQuery build()

Builds a SpanQuery.

Specified by:

build in interface ObjectBuilder<SpanQuery>

Throws:

java.lang.NullPointerException - if some of the required fields are null.