Package co.elastic.clients.elasticsearch.eql

Class SearchRequest.Builder

java.lang.Object
co.elastic.clients.elasticsearch.eql.SearchRequest.Builder
All Implemented Interfaces:
ObjectBuilder<SearchRequest>
Enclosing class:
SearchRequest
public static class SearchRequest.Builder
extends java.lang.Object
implements ObjectBuilder<SearchRequest>
Builder for SearchRequest.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • index

      public SearchRequest.Builder index​(java.lang.String value)
      The name of the index to scope the operation

      API name: index

    • allowNoIndices

      public SearchRequest.Builder allowNoIndices​(@Nullable java.lang.Boolean value)
      API name: allow_no_indices

    • expandWildcards

      public SearchRequest.Builder expandWildcards​(@Nullable java.util.List<ExpandWildcardOptions> value)
      API name: expand_wildcards

    • expandWildcards

      public SearchRequest.Builder expandWildcards​(ExpandWildcardOptions... value)
      API name: expand_wildcards

    • addExpandWildcards

      public SearchRequest.Builder addExpandWildcards​(ExpandWildcardOptions value)
      Add a value to expandWildcards(List), creating the list if needed. 4

    • ignoreUnavailable

      public SearchRequest.Builder ignoreUnavailable​(@Nullable java.lang.Boolean value)
      If true, missing or closed indices are not included in the response.

      API name: ignore_unavailable

    • query

      public SearchRequest.Builder query​(java.lang.String value)
      EQL query you wish to run.

      API name: query

    • caseSensitive

      public SearchRequest.Builder caseSensitive​(@Nullable java.lang.Boolean value)
      API name: case_sensitive

    • eventCategoryField

      public SearchRequest.Builder eventCategoryField​(@Nullable java.lang.String value)
      Field containing the event classification, such as process, file, or network.

      API name: event_category_field

    • tiebreakerField

      public SearchRequest.Builder tiebreakerField​(@Nullable java.lang.String value)
      Field used to sort hits with the same timestamp in ascending order

      API name: tiebreaker_field

    • timestampField

      public SearchRequest.Builder timestampField​(@Nullable java.lang.String value)
      Field containing event timestamp. Default "@timestamp"

      API name: timestamp_field

    • fetchSize

      public SearchRequest.Builder fetchSize​(@Nullable java.lang.Number value)
      Maximum number of events to search at a time for sequence queries.

      API name: fetch_size

    • filter

      public SearchRequest.Builder filter​(@Nullable java.util.List<Query> value)
      Query, written in Query DSL, used to filter the events on which the EQL query runs.

      API name: filter

    • filter

      public SearchRequest.Builder filter​(Query... value)
      Query, written in Query DSL, used to filter the events on which the EQL query runs.

      API name: filter

    • addFilter

      public SearchRequest.Builder addFilter​(Query value)
      Add a value to filter(List), creating the list if needed. 4

    • filter

      public SearchRequest.Builder filter​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      Set filter(List) to a singleton list.

    • addFilter

      public SearchRequest.Builder addFilter​(java.util.function.Function<Query.Builder,​ObjectBuilder<Query>> fn)
      Add a value to filter(List), creating the list if needed. 5

    • keepAlive

      public SearchRequest.Builder keepAlive​(@Nullable java.lang.String value)
      API name: keep_alive

    • keepOnCompletion

      public SearchRequest.Builder keepOnCompletion​(@Nullable java.lang.Boolean value)
      API name: keep_on_completion

    • waitForCompletionTimeout

      public SearchRequest.Builder waitForCompletionTimeout​(@Nullable java.lang.String value)
      API name: wait_for_completion_timeout

    • size

      public SearchRequest.Builder size​(@Nullable jakarta.json.JsonValue value)
      For basic queries, the maximum number of matching events to return. Defaults to 10

      API name: size

    • fields

      public SearchRequest.Builder fields​(@Nullable java.util.List<jakarta.json.JsonValue> value)
      Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.

      API name: fields

    • fields

      public SearchRequest.Builder fields​(jakarta.json.JsonValue... value)
      Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.

      API name: fields

    • addFields

      public SearchRequest.Builder addFields​(jakarta.json.JsonValue value)
      Add a value to fields(List), creating the list if needed. 4

    • resultPosition

      public SearchRequest.Builder resultPosition​(@Nullable ResultPosition value)
      API name: result_position

    • build

      public SearchRequest build()
      Builds a SearchRequest.
      Specified by:
      build in interface ObjectBuilder<SearchRequest>
      Throws:
      java.lang.NullPointerException - if some of the required fields are null.