Package co.elastic.clients.elasticsearch.eql

Class HitsSequence.Builder<TEvent>

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<HitsSequence.Builder<TEvent>>

co.elastic.clients.elasticsearch.eql.HitsSequence.Builder<TEvent>

All Implemented Interfaces:

WithJson<HitsSequence.Builder<TEvent>>, ObjectBuilder<HitsSequence<TEvent>>

Enclosing class:

HitsSequence<TEvent>

public static class HitsSequence.Builder<TEvent>
extends WithJsonObjectBuilderBase<HitsSequence.Builder<TEvent>>
implements ObjectBuilder<HitsSequence<TEvent>>

Builder for HitsSequence.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
HitsSequence<TEvent>	build()	Builds a HitsSequence.
final HitsSequence.Builder<TEvent>	events(HitsEvent<TEvent> value, HitsEvent<TEvent>... values)	Required - Contains events matching the query.
final HitsSequence.Builder<TEvent>	events(Function<HitsEvent.Builder<TEvent>,ObjectBuilder<HitsEvent<TEvent>>> fn)	Required - Contains events matching the query.
final HitsSequence.Builder<TEvent>	events(List<HitsEvent<TEvent>> list)	Required - Contains events matching the query.
final HitsSequence.Builder<TEvent>	joinKeys(JsonData value, JsonData... values)	Shared field values used to constrain matches in the sequence.
final HitsSequence.Builder<TEvent>	joinKeys(List<JsonData> list)	Shared field values used to constrain matches in the sequence.
protected HitsSequence.Builder<TEvent>	self()
final HitsSequence.Builder<TEvent>	tEventSerializer(JsonpSerializer<TEvent> value)	Serializer for TEvent.

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

Methods inherited from class co.elastic.clients.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

events

public final HitsSequence.Builder<TEvent> events(List<HitsEvent<TEvent>> list)

Required - Contains events matching the query. Each object represents a matching event.

API name: events

Adds all elements of list to events.

events

public final HitsSequence.Builder<TEvent> events(HitsEvent<TEvent> value,
 HitsEvent<TEvent>... values)

Required - Contains events matching the query. Each object represents a matching event.

API name: events

Adds one or more values to events.

events

public final HitsSequence.Builder<TEvent> events(Function<HitsEvent.Builder<TEvent>,ObjectBuilder<HitsEvent<TEvent>>> fn)

Required - Contains events matching the query. Each object represents a matching event.

API name: events

Adds a value to events using a builder lambda.

joinKeys

public final HitsSequence.Builder<TEvent> joinKeys(List<JsonData> list)

Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.

API name: join_keys

Adds all elements of list to joinKeys.

joinKeys

public final HitsSequence.Builder<TEvent> joinKeys(JsonData value,
 JsonData... values)

Shared field values used to constrain matches in the sequence. These are defined using the by keyword in the EQL query syntax.

API name: join_keys

Adds one or more values to joinKeys.

tEventSerializer

public final HitsSequence.Builder<TEvent> tEventSerializer(@Nullable
 JsonpSerializer<TEvent> value)

Serializer for TEvent. If not set, an attempt will be made to find a serializer from the JSON context.

self

protected HitsSequence.Builder<TEvent> self()

Specified by:

self in class WithJsonObjectBuilderBase<HitsSequence.Builder<TEvent>>

build

public HitsSequence<TEvent> build()

Builds a HitsSequence.

Specified by:

build in interface ObjectBuilder<TEvent>

Throws:

NullPointerException - if some of the required fields are null.