Package co.elastic.clients.elasticsearch.eql

Class EqlHits.Builder<TEvent>

java.lang.Object

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

All Implemented Interfaces:

ObjectBuilder<EqlHits<TEvent>>

Enclosing class:

EqlHits<TEvent>

public static class EqlHits.Builder<TEvent>
extends java.lang.Object
implements ObjectBuilder<EqlHits<TEvent>>

Builder for EqlHits.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EqlHits.Builder<TEvent>	addEvents(HitsEvent<TEvent> value)	Add a value to events(List), creating the list if needed.
EqlHits.Builder<TEvent>	addEvents(java.util.function.Function<HitsEvent.Builder<TEvent>,ObjectBuilder<HitsEvent<TEvent>>> fn)	Add a value to events(List), creating the list if needed.
EqlHits.Builder<TEvent>	addSequences(HitsSequence<TEvent> value)	Add a value to sequences(List), creating the list if needed.
EqlHits.Builder<TEvent>	addSequences(java.util.function.Function<HitsSequence.Builder<TEvent>,ObjectBuilder<HitsSequence<TEvent>>> fn)	Add a value to sequences(List), creating the list if needed.
EqlHits<TEvent>	build()	Builds a EqlHits.
EqlHits.Builder<TEvent>	events(HitsEvent<TEvent>... value)	Contains events matching the query.
EqlHits.Builder<TEvent>	events(java.util.function.Function<HitsEvent.Builder<TEvent>,ObjectBuilder<HitsEvent<TEvent>>> fn)	Set events(List) to a singleton list.
EqlHits.Builder<TEvent>	events(java.util.List<HitsEvent<TEvent>> value)	Contains events matching the query.
EqlHits.Builder<TEvent>	sequences(HitsSequence<TEvent>... value)	Contains event sequences matching the query.
EqlHits.Builder<TEvent>	sequences(java.util.function.Function<HitsSequence.Builder<TEvent>,ObjectBuilder<HitsSequence<TEvent>>> fn)	Set sequences(List) to a singleton list.
EqlHits.Builder<TEvent>	sequences(java.util.List<HitsSequence<TEvent>> value)	Contains event sequences matching the query.
EqlHits.Builder<TEvent>	tEventSerializer(JsonpSerializer<TEvent> value)	Serializer for TEvent.
EqlHits.Builder<TEvent>	total(TotalHits value)	Metadata about the number of matching events or sequences.
EqlHits.Builder<TEvent>	total(java.util.function.Function<TotalHits.Builder,ObjectBuilder<TotalHits>> fn)	Metadata about the number of matching events or sequences.

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

total

public EqlHits.Builder<TEvent> total(@Nullable
TotalHits value)

Metadata about the number of matching events or sequences.

API name: total

total

public EqlHits.Builder<TEvent> total(java.util.function.Function<TotalHits.Builder,ObjectBuilder<TotalHits>> fn)

Metadata about the number of matching events or sequences.

API name: total

events

public EqlHits.Builder<TEvent> events(@Nullable
java.util.List<HitsEvent<TEvent>> value)

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

API name: events

events

public EqlHits.Builder<TEvent> events(HitsEvent<TEvent>... value)

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

API name: events

addEvents

public EqlHits.Builder<TEvent> addEvents(HitsEvent<TEvent> value)

Add a value to events(List), creating the list if needed.

events

public EqlHits.Builder<TEvent> events(java.util.function.Function<HitsEvent.Builder<TEvent>,ObjectBuilder<HitsEvent<TEvent>>> fn)

Set events(List) to a singleton list.

addEvents

public EqlHits.Builder<TEvent> addEvents(java.util.function.Function<HitsEvent.Builder<TEvent>,ObjectBuilder<HitsEvent<TEvent>>> fn)

Add a value to events(List), creating the list if needed.

sequences

public EqlHits.Builder<TEvent> sequences(@Nullable
java.util.List<HitsSequence<TEvent>> value)

Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.

API name: sequences

sequences

public EqlHits.Builder<TEvent> sequences(HitsSequence<TEvent>... value)

Contains event sequences matching the query. Each object represents a matching sequence. This parameter is only returned for EQL queries containing a sequence.

API name: sequences

addSequences

public EqlHits.Builder<TEvent> addSequences(HitsSequence<TEvent> value)

Add a value to sequences(List), creating the list if needed.

sequences

public EqlHits.Builder<TEvent> sequences(java.util.function.Function<HitsSequence.Builder<TEvent>,ObjectBuilder<HitsSequence<TEvent>>> fn)

Set sequences(List) to a singleton list.

addSequences

public EqlHits.Builder<TEvent> addSequences(java.util.function.Function<HitsSequence.Builder<TEvent>,ObjectBuilder<HitsSequence<TEvent>>> fn)

Add a value to sequences(List), creating the list if needed.

tEventSerializer

public EqlHits.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.

build

public EqlHits<TEvent> build()

Builds a EqlHits.

Specified by:

build in interface ObjectBuilder<TEvent>

Throws:

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