Class DatafeedConfig.Builder
- All Implemented Interfaces:
ObjectBuilder<DatafeedConfig>
- Enclosing class:
- DatafeedConfig
public static class DatafeedConfig.Builder extends ObjectBuilderBase implements ObjectBuilder<DatafeedConfig>
DatafeedConfig
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description DatafeedConfig.Builder
aggregations(java.lang.String key, Aggregation value)
If set, the datafeed performs aggregation searches.DatafeedConfig.Builder
aggregations(java.lang.String key, java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)
If set, the datafeed performs aggregation searches.DatafeedConfig.Builder
aggregations(java.util.Map<java.lang.String,Aggregation> map)
If set, the datafeed performs aggregation searches.DatafeedConfig
build()
Builds aDatafeedConfig
.DatafeedConfig.Builder
chunkingConfig(ChunkingConfig value)
Datafeeds might be required to search over long time periods, for several months or years.DatafeedConfig.Builder
chunkingConfig(java.util.function.Function<ChunkingConfig.Builder,ObjectBuilder<ChunkingConfig>> fn)
Datafeeds might be required to search over long time periods, for several months or years.DatafeedConfig.Builder
datafeedId(java.lang.String value)
A numerical character string that uniquely identifies the datafeed.DatafeedConfig.Builder
delayedDataCheckConfig(DelayedDataCheckConfig value)
Specifies whether the datafeed checks for missing data and the size of the window.DatafeedConfig.Builder
delayedDataCheckConfig(java.util.function.Function<DelayedDataCheckConfig.Builder,ObjectBuilder<DelayedDataCheckConfig>> fn)
Specifies whether the datafeed checks for missing data and the size of the window.DatafeedConfig.Builder
frequency(java.lang.String value)
The interval at which scheduled queries are made while the datafeed runs in real time.DatafeedConfig.Builder
indexes(java.lang.String value, java.lang.String... values)
API name:indexes
DatafeedConfig.Builder
indexes(java.util.List<java.lang.String> list)
API name:indexes
DatafeedConfig.Builder
indices(java.lang.String value, java.lang.String... values)
Required - An array of index names.DatafeedConfig.Builder
indices(java.util.List<java.lang.String> list)
Required - An array of index names.DatafeedConfig.Builder
indicesOptions(IndicesOptions value)
Specifies index expansion options that are used during search.DatafeedConfig.Builder
indicesOptions(java.util.function.Function<IndicesOptions.Builder,ObjectBuilder<IndicesOptions>> fn)
Specifies index expansion options that are used during search.DatafeedConfig.Builder
jobId(java.lang.String value)
API name:job_id
DatafeedConfig.Builder
maxEmptySearches(java.lang.Integer value)
If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents.DatafeedConfig.Builder
query(Query value)
Required - The Elasticsearch query domain-specific language (DSL).DatafeedConfig.Builder
query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)
Required - The Elasticsearch query domain-specific language (DSL).DatafeedConfig.Builder
queryDelay(java.lang.String value)
The number of seconds behind real time that data is queried.DatafeedConfig.Builder
runtimeMappings(java.lang.String key, RuntimeField value)
Specifies runtime fields for the datafeed search.DatafeedConfig.Builder
runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)
Specifies runtime fields for the datafeed search.DatafeedConfig.Builder
runtimeMappings(java.util.Map<java.lang.String,RuntimeField> map)
Specifies runtime fields for the datafeed search.DatafeedConfig.Builder
scriptFields(java.lang.String key, ScriptField value)
Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.DatafeedConfig.Builder
scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)
Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.DatafeedConfig.Builder
scriptFields(java.util.Map<java.lang.String,ScriptField> map)
Specifies scripts that evaluate custom expressions and returns script fields to the datafeed.DatafeedConfig.Builder
scrollSize(java.lang.Integer value)
The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations.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
-
aggregations
If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.API name:
aggregations
Adds all entries of
map
toaggregations
. -
aggregations
If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.API name:
aggregations
Adds an entry to
aggregations
. -
aggregations
public final DatafeedConfig.Builder aggregations(java.lang.String key, java.util.function.Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)If set, the datafeed performs aggregation searches. Support for aggregations is limited and should be used only with low cardinality data.API name:
aggregations
Adds an entry to
aggregations
using a builder lambda. -
chunkingConfig
Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option.API name:
chunking_config
-
chunkingConfig
public final DatafeedConfig.Builder chunkingConfig(java.util.function.Function<ChunkingConfig.Builder,ObjectBuilder<ChunkingConfig>> fn)Datafeeds might be required to search over long time periods, for several months or years. This search is split into time chunks in order to ensure the load on Elasticsearch is managed. Chunking configuration controls how the size of these time chunks are calculated and is an advanced configuration option.API name:
chunking_config
-
datafeedId
A numerical character string that uniquely identifies the datafeed. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.API name:
datafeed_id
-
delayedDataCheckConfig
Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that thequery_delay
option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.API name:
delayed_data_check_config
-
delayedDataCheckConfig
public final DatafeedConfig.Builder delayedDataCheckConfig(java.util.function.Function<DelayedDataCheckConfig.Builder,ObjectBuilder<DelayedDataCheckConfig>> fn)Specifies whether the datafeed checks for missing data and the size of the window. The datafeed can optionally search over indices that have already been read in an effort to determine whether any data has subsequently been added to the index. If missing data is found, it is a good indication that thequery_delay
option is set too low and the data is being indexed after the datafeed has passed that moment in time. This check runs only on real-time datafeeds.API name:
delayed_data_check_config
-
frequency
The interval at which scheduled queries are made while the datafeed runs in real time. The default value is either the bucket span for short bucket spans, or, for longer bucket spans, a sensible fraction of the bucket span. For example:150s
. When frequency is shorter than the bucket span, interim results for the last (partial) bucket are written then eventually overwritten by the full bucket results. If the datafeed uses aggregations, this value must be divisible by the interval of the date histogram aggregation.API name:
frequency
-
indexes
API name:indexes
Adds all elements of
list
toindexes
. -
indexes
API name:indexes
Adds one or more values to
indexes
. -
indices
Required - An array of index names. Wildcards are supported.API name:
indices
Adds all elements of
list
toindices
. -
indices
Required - An array of index names. Wildcards are supported.API name:
indices
Adds one or more values to
indices
. -
indicesOptions
Specifies index expansion options that are used during search.API name:
indices_options
-
indicesOptions
public final DatafeedConfig.Builder indicesOptions(java.util.function.Function<IndicesOptions.Builder,ObjectBuilder<IndicesOptions>> fn)Specifies index expansion options that are used during search.API name:
indices_options
-
jobId
API name:job_id
-
maxEmptySearches
If a real-time datafeed has never seen any data (including during any initial training period) then it will automatically stop itself and close its associated job after this many real-time searches that return no documents. In other words, it will stop afterfrequency
timesmax_empty_searches
of real-time operation. If not set then a datafeed with no end time that sees no data will remain started until it is explicitly stopped.API name:
max_empty_searches
-
query
Required - The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.API name:
query
-
query
public final DatafeedConfig.Builder query(java.util.function.Function<Query.Builder,ObjectBuilder<Query>> fn)Required - The Elasticsearch query domain-specific language (DSL). This value corresponds to the query object in an Elasticsearch search POST body. All the options that are supported by Elasticsearch can be used, as this object is passed verbatim to Elasticsearch.API name:
query
-
queryDelay
The number of seconds behind real time that data is queried. For example, if data from 10:04 a.m. might not be searchable in Elasticsearch until 10:06 a.m., set this property to 120 seconds. The default value is randomly selected between60s
and120s
. This randomness improves the query performance when there are multiple jobs running on the same node.API name:
query_delay
-
runtimeMappings
public final DatafeedConfig.Builder runtimeMappings(java.util.Map<java.lang.String,RuntimeField> map)Specifies runtime fields for the datafeed search.API name:
runtime_mappings
Adds all entries of
map
toruntimeMappings
. -
runtimeMappings
Specifies runtime fields for the datafeed search.API name:
runtime_mappings
Adds an entry to
runtimeMappings
. -
runtimeMappings
public final DatafeedConfig.Builder runtimeMappings(java.lang.String key, java.util.function.Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)Specifies runtime fields for the datafeed search.API name:
runtime_mappings
Adds an entry to
runtimeMappings
using a builder lambda. -
scriptFields
Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.API name:
script_fields
Adds all entries of
map
toscriptFields
. -
scriptFields
Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.API name:
script_fields
Adds an entry to
scriptFields
. -
scriptFields
public final DatafeedConfig.Builder scriptFields(java.lang.String key, java.util.function.Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)Specifies scripts that evaluate custom expressions and returns script fields to the datafeed. The detector configuration objects in a job can contain functions that use these script fields.API name:
script_fields
Adds an entry to
scriptFields
using a builder lambda. -
scrollSize
The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value ofindex.max_result_window
, which is 10,000 by default.API name:
scroll_size
-
build
Builds aDatafeedConfig
.- Specified by:
build
in interfaceObjectBuilder<DatafeedConfig>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-