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

Class SpanGapQuery.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

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

All Implemented Interfaces:

CopyableBuilder<SpanGapQuery.Builder,SpanGapQuery>, MutableBuilder<SpanGapQuery.Builder,SpanGapQuery>, ObjectBuilder<SpanGapQuery>

Enclosing class:

SpanGapQuery

public static class SpanGapQuery.Builder
extends ObjectBuilderBase
implements CopyableBuilder<SpanGapQuery.Builder,SpanGapQuery>

Builder for SpanGapQuery.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SpanGapQuery	build()	Builds a SpanGapQuery.
SpanGapQuery.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final SpanGapQuery.Builder	field(String value)	Required - The path to a field or an array of paths.
final SpanGapQuery.Builder	spanWidth(int value)	Required -

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public SpanGapQuery.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<SpanGapQuery.Builder,SpanGapQuery>

Returns:

a new builder instance.

field

@Nonnull
public final SpanGapQuery.Builder field(String value)

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

@Nonnull
public final SpanGapQuery.Builder spanWidth(int value)

Required -

build

@Nonnull
public SpanGapQuery build()

Builds a SpanGapQuery.

Specified by:

build in interface ObjectBuilder<SpanGapQuery>

Throws:

NullPointerException - if some of the required fields are null.