Package co.elastic.clients.elasticsearch.eql

Class EqlSearchResponseBase.AbstractBuilder<TEvent,BuilderT extends EqlSearchResponseBase.AbstractBuilder<TEvent,BuilderT>>

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch.eql.EqlSearchResponseBase.AbstractBuilder<TEvent,BuilderT>
All Implemented Interfaces:
WithJson<BuilderT>
Direct Known Subclasses:
EqlGetResponse.Builder, EqlSearchResponse.Builder
Enclosing class:
EqlSearchResponseBase<TEvent>
public abstract static class EqlSearchResponseBase.AbstractBuilder<TEvent,BuilderT extends EqlSearchResponseBase.AbstractBuilder<TEvent,BuilderT>> extends WithJsonObjectBuilderBase<BuilderT>

  • Constructor Details

    • AbstractBuilder

      public AbstractBuilder()

  • Method Details

    • id

      public final BuilderT id(@Nullable String value)
      Identifier for the search.

      API name: id

    • isPartial

      public final BuilderT isPartial(@Nullable Boolean value)
      If true, the response does not contain complete search results.

      API name: is_partial

    • isRunning

      public final BuilderT isRunning(@Nullable Boolean value)
      If true, the search request is still executing.

      API name: is_running

    • took

      public final BuilderT took(@Nullable Long value)
      Milliseconds it took Elasticsearch to execute the request.

      API name: took

    • timedOut

      public final BuilderT timedOut(@Nullable Boolean value)
      If true, the request timed out before completion.

      API name: timed_out

    • hits

      public final BuilderT hits(EqlHits<TEvent> value)
      Required - Contains matching events and sequences. Also contains related metadata.

      API name: hits

    • hits

      public final BuilderT hits(Function<EqlHits.Builder<TEvent>,ObjectBuilder<EqlHits<TEvent>>> fn)
      Required - Contains matching events and sequences. Also contains related metadata.

      API name: hits

    • shardFailures

      public final BuilderT shardFailures(List<ShardFailure> list)
      Contains information about shard failures (if any), in case allow_partial_search_results=true

      API name: shard_failures

      Adds all elements of list to shardFailures.

    • shardFailures

      public final BuilderT shardFailures(ShardFailure value, ShardFailure... values)
      Contains information about shard failures (if any), in case allow_partial_search_results=true

      API name: shard_failures

      Adds one or more values to shardFailures.

    • shardFailures

      public final BuilderT shardFailures(Function<ShardFailure.Builder,ObjectBuilder<ShardFailure>> fn)
      Contains information about shard failures (if any), in case allow_partial_search_results=true

      API name: shard_failures

      Adds a value to shardFailures using a builder lambda.

    • tEventSerializer

      public final BuilderT 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 abstract BuilderT self()
      Specified by:
      self in class WithJsonObjectBuilderBase<BuilderT extends EqlSearchResponseBase.AbstractBuilder<TEvent,BuilderT>>