Class EqlHits.Builder<TEvent>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
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 ObjectBuilderBase
implements ObjectBuilder<EqlHits<TEvent>>
Builder for EqlHits.
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • total

      public final EqlHits.Builder<TEvent> total​(@Nullable TotalHits value)
      Metadata about the number of matching events or sequences.

      API name: total

    • total

      public final 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 final EqlHits.Builder<TEvent> events​(java.util.List<HitsEvent<TEvent>> list)
      Contains events matching the query. Each object represents a matching event.

      API name: events

      Adds all elements of list to events.

    • events

      public final EqlHits.Builder<TEvent> events​(HitsEvent<TEvent> value, HitsEvent<TEvent>... values)
      Contains events matching the query. Each object represents a matching event.

      API name: events

      Adds one or more values to events.

    • events

      public final EqlHits.Builder<TEvent> events​(java.util.function.Function<HitsEvent.Builder<TEvent>,​ObjectBuilder<HitsEvent<TEvent>>> fn)
      Contains events matching the query. Each object represents a matching event.

      API name: events

      Adds a value to events using a builder lambda.

    • sequences

      public final EqlHits.Builder<TEvent> sequences​(java.util.List<HitsSequence<TEvent>> list)
      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

      Adds all elements of list to sequences.

    • sequences

      public final EqlHits.Builder<TEvent> sequences​(HitsSequence<TEvent> value, HitsSequence<TEvent>... values)
      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

      Adds one or more values to sequences.

    • sequences

      public final EqlHits.Builder<TEvent> sequences​(java.util.function.Function<HitsSequence.Builder<TEvent>,​ObjectBuilder<HitsSequence<TEvent>>> fn)
      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

      Adds a value to sequences using a builder lambda.

    • tEventSerializer

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