Class EqlSearchRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.elasticsearch.eql.EqlSearchRequest.Builder
- All Implemented Interfaces:
ObjectBuilder<EqlSearchRequest>
- Enclosing class:
- EqlSearchRequest
public static class EqlSearchRequest.Builder extends ObjectBuilderBase implements ObjectBuilder<EqlSearchRequest>
Builder for
EqlSearchRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description EqlSearchRequest.Builder
allowNoIndices(java.lang.Boolean value)
API name:allow_no_indices
EqlSearchRequest
build()
Builds aEqlSearchRequest
.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(ExpandWildcard value, ExpandWildcard... values)
API name:expand_wildcards
EqlSearchRequest.Builder
expandWildcards(java.util.List<ExpandWildcard> list)
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(FieldAndFormat value)
Array of wildcard (*) patterns.EqlSearchRequest.Builder
fields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)
Array of wildcard (*) patterns.EqlSearchRequest.Builder
filter(Query value, Query... values)
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)
Query, written in Query DSL, used to filter the events on which the EQL query runs.EqlSearchRequest.Builder
filter(java.util.List<Query> list)
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 operationEqlSearchRequest.Builder
keepAlive(Time value)
API name:keep_alive
EqlSearchRequest.Builder
keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
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(java.lang.Number 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 orderEqlSearchRequest.Builder
timestampField(java.lang.String value)
Field containing event timestamp.EqlSearchRequest.Builder
waitForCompletionTimeout(Time value)
API name:wait_for_completion_timeout
EqlSearchRequest.Builder
waitForCompletionTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)
API name:wait_for_completion_timeout
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
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
-
allowNoIndices
API name:allow_no_indices
-
caseSensitive
API name:case_sensitive
-
eventCategoryField
Field containing the event classification, such as process, file, or network.API name:
event_category_field
-
expandWildcards
API name:expand_wildcards
Adds all elements of
list
toexpandWildcards
. -
expandWildcards
public final EqlSearchRequest.Builder expandWildcards(ExpandWildcard value, ExpandWildcard... values)API name:expand_wildcards
Adds one or more values to
expandWildcards
. -
fetchSize
Maximum number of events to search at a time for sequence queries.API name:
fetch_size
-
fields
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 final EqlSearchRequest.Builder fields(java.util.function.Function<FieldAndFormat.Builder,ObjectBuilder<FieldAndFormat>> fn)Array of wildcard (*) patterns. The response returns values for field names matching these patterns in the fields property of each hit.API name:
fields
-
filter
Query, written in Query DSL, used to filter the events on which the EQL query runs.API name:
filter
Adds all elements of
list
tofilter
. -
filter
Query, written in Query DSL, used to filter the events on which the EQL query runs.API name:
filter
Adds one or more values to
filter
. -
filter
public final EqlSearchRequest.Builder filter(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)Query, written in Query DSL, used to filter the events on which the EQL query runs.API name:
filter
Adds a value to
filter
using a builder lambda. -
index
Required - The name of the index to scope the operationAPI name:
index
-
keepAlive
API name:keep_alive
-
keepAlive
public final EqlSearchRequest.Builder keepAlive(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)API name:keep_alive
-
keepOnCompletion
API name:keep_on_completion
-
query
Required - EQL query you wish to run.API name:
query
-
resultPosition
API name:result_position
-
size
For basic queries, the maximum number of matching events to return. Defaults to 10API name:
size
-
tiebreakerField
Field used to sort hits with the same timestamp in ascending orderAPI name:
tiebreaker_field
-
timestampField
Field containing event timestamp. Default "@timestamp"API name:
timestamp_field
-
waitForCompletionTimeout
API name:wait_for_completion_timeout
-
waitForCompletionTimeout
public final EqlSearchRequest.Builder waitForCompletionTimeout(java.util.function.Function<Time.Builder,ObjectBuilder<Time>> fn)API name:wait_for_completion_timeout
-
build
Builds aEqlSearchRequest
.- Specified by:
build
in interfaceObjectBuilder<EqlSearchRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-