Package co.elastic.clients.elasticsearch.eql

Class EqlSearchRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.eql.EqlSearchRequest.Builder

All Implemented Interfaces:

ObjectBuilder<EqlSearchRequest>

Enclosing class:

EqlSearchRequest

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

Builder for EqlSearchRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
EqlSearchRequest.Builder	addExpandWildcards(ExpandWildcardOptions value)	Add a value to expandWildcards(List), creating the list if needed.
EqlSearchRequest.Builder	addFields(jakarta.json.JsonValue value)	Add a value to fields(List), creating the list if needed.
EqlSearchRequest.Builder	addFilter(Query value)	Add a value to filter(List), creating the list if needed.
EqlSearchRequest.Builder	addFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	Add a value to filter(List), creating the list if needed.
EqlSearchRequest.Builder	allowNoIndices(java.lang.Boolean value)	API name: allow_no_indices
EqlSearchRequest	build()	Builds a EqlSearchRequest.
EqlSearchRequest.Builder	caseSensitive(java.lang.Boolean value)	API name: case_sensitive
EqlSearchRequest.Builder	eventCategoryField(java.lang.String value)	Field containing the event classification, such as process, file, or network.
EqlSearchRequest.Builder	expandWildcards(ExpandWildcardOptions... value)	API name: expand_wildcards
EqlSearchRequest.Builder	expandWildcards(java.util.List<ExpandWildcardOptions> value)	API name: expand_wildcards
EqlSearchRequest.Builder	fetchSize(java.lang.Number value)	Maximum number of events to search at a time for sequence queries.
EqlSearchRequest.Builder	fields(jakarta.json.JsonValue... value)	Array of wildcard (*) patterns.
EqlSearchRequest.Builder	fields(java.util.List<jakarta.json.JsonValue> value)	Array of wildcard (*) patterns.
EqlSearchRequest.Builder	filter(Query... value)	Query, written in Query DSL, used to filter the events on which the EQL query runs.
EqlSearchRequest.Builder	filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)	Set filter(List) to a singleton list.
EqlSearchRequest.Builder	filter(java.util.List<Query> value)	Query, written in Query DSL, used to filter the events on which the EQL query runs.
EqlSearchRequest.Builder	ignoreUnavailable(java.lang.Boolean value)	If true, missing or closed indices are not included in the response.
EqlSearchRequest.Builder	index(java.lang.String value)	Required - The name of the index to scope the operation
EqlSearchRequest.Builder	keepAlive(java.lang.String value)	API name: keep_alive
EqlSearchRequest.Builder	keepOnCompletion(java.lang.Boolean value)	API name: keep_on_completion
EqlSearchRequest.Builder	query(java.lang.String value)	Required - EQL query you wish to run.
EqlSearchRequest.Builder	resultPosition(ResultPosition value)	API name: result_position
EqlSearchRequest.Builder	size(jakarta.json.JsonValue value)	For basic queries, the maximum number of matching events to return.
EqlSearchRequest.Builder	tiebreakerField(java.lang.String value)	Field used to sort hits with the same timestamp in ascending order
EqlSearchRequest.Builder	timestampField(java.lang.String value)	Field containing event timestamp.
EqlSearchRequest.Builder	waitForCompletionTimeout(java.lang.String value)	API name: wait_for_completion_timeout

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

index

public EqlSearchRequest.Builder index(java.lang.String value)

Required - The name of the index to scope the operation

API name: index

allowNoIndices

public EqlSearchRequest.Builder allowNoIndices(@Nullable
java.lang.Boolean value)

API name: allow_no_indices

expandWildcards

public EqlSearchRequest.Builder expandWildcards(@Nullable
java.util.List<ExpandWildcardOptions> value)

API name: expand_wildcards

expandWildcards

public EqlSearchRequest.Builder expandWildcards(ExpandWildcardOptions... value)

API name: expand_wildcards

addExpandWildcards

public EqlSearchRequest.Builder addExpandWildcards(ExpandWildcardOptions value)

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

ignoreUnavailable

public EqlSearchRequest.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 EqlSearchRequest.Builder query(java.lang.String value)

Required - EQL query you wish to run.

API name: query

caseSensitive

public EqlSearchRequest.Builder caseSensitive(@Nullable
java.lang.Boolean value)

API name: case_sensitive

eventCategoryField

public EqlSearchRequest.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 EqlSearchRequest.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 EqlSearchRequest.Builder timestampField(@Nullable
java.lang.String value)

Field containing event timestamp. Default "@timestamp"

API name: timestamp_field

fetchSize

public EqlSearchRequest.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 EqlSearchRequest.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 EqlSearchRequest.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 EqlSearchRequest.Builder addFilter(Query value)

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

filter

public EqlSearchRequest.Builder filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)

Set filter(List) to a singleton list.

addFilter

public EqlSearchRequest.Builder addFilter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)

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

keepAlive

public EqlSearchRequest.Builder keepAlive(@Nullable
java.lang.String value)

API name: keep_alive

keepOnCompletion

public EqlSearchRequest.Builder keepOnCompletion(@Nullable
java.lang.Boolean value)

API name: keep_on_completion

waitForCompletionTimeout

public EqlSearchRequest.Builder waitForCompletionTimeout(@Nullable
java.lang.String value)

API name: wait_for_completion_timeout

size

public EqlSearchRequest.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 EqlSearchRequest.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 EqlSearchRequest.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 EqlSearchRequest.Builder addFields(jakarta.json.JsonValue value)

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

resultPosition

public EqlSearchRequest.Builder resultPosition(@Nullable
ResultPosition value)

API name: result_position

build

public EqlSearchRequest build()

Builds a EqlSearchRequest.

Specified by:

build in interface ObjectBuilder<EqlSearchRequest>

Throws:

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