Package co.elastic.clients.elasticsearch.ml

Class DatafeedConfig.Builder

java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<DatafeedConfig.Builder>
co.elastic.clients.elasticsearch.ml.DatafeedConfig.Builder
All Implemented Interfaces:
WithJson<DatafeedConfig.Builder>, ObjectBuilder<DatafeedConfig>
Enclosing class:
DatafeedConfig
public static class DatafeedConfig.Builder extends WithJsonObjectBuilderBase<DatafeedConfig.Builder> implements ObjectBuilder<DatafeedConfig>
Builder for DatafeedConfig.

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • aggregations

      public final DatafeedConfig.Builder aggregations(Map<String,Aggregation> map)
      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 to aggregations.

    • aggregations

      public final DatafeedConfig.Builder aggregations(String key, Aggregation value)
      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(String key, AggregationVariant value)
      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(String key, 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

      public final DatafeedConfig.Builder chunkingConfig(@Nullable ChunkingConfig value)
      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(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

      public final DatafeedConfig.Builder datafeedId(@Nullable String value)
      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. The default value is the job identifier.

      API name: datafeed_id

    • delayedDataCheckConfig

      public final DatafeedConfig.Builder delayedDataCheckConfig(@Nullable DelayedDataCheckConfig value)
      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 the query_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(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 the query_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

      public final DatafeedConfig.Builder frequency(@Nullable Time value)
      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

    • frequency

      public final DatafeedConfig.Builder frequency(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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

    • indices

      public final DatafeedConfig.Builder indices(List<String> list)
      An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the remote_cluster_client role.

      API name: indices

      Adds all elements of list to indices.

    • indices

      public final DatafeedConfig.Builder indices(String value, String... values)
      An array of index names. Wildcards are supported. If any indices are in remote clusters, the machine learning nodes must have the remote_cluster_client role.

      API name: indices

      Adds one or more values to indices.

    • indicesOptions

      public final DatafeedConfig.Builder indicesOptions(@Nullable IndicesOptions value)
      Specifies index expansion options that are used during search.

      API name: indices_options

    • indicesOptions

      public final DatafeedConfig.Builder indicesOptions(Function<IndicesOptions.Builder,ObjectBuilder<IndicesOptions>> fn)
      Specifies index expansion options that are used during search.

      API name: indices_options

    • jobId

      public final DatafeedConfig.Builder jobId(@Nullable String value)
      API name: job_id

    • maxEmptySearches

      public final DatafeedConfig.Builder maxEmptySearches(@Nullable 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. In other words, it will stop after frequency times max_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

      public final DatafeedConfig.Builder query(@Nullable Query value)
      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(Function<Query.Builder,ObjectBuilder<Query>> fn)
      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(QueryVariant value)
      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

      public final DatafeedConfig.Builder queryDelay(@Nullable Time value)
      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 between 60s and 120s. This randomness improves the query performance when there are multiple jobs running on the same node.

      API name: query_delay

    • queryDelay

      public final DatafeedConfig.Builder queryDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)
      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 between 60s and 120s. 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(Map<String,RuntimeField> map)
      Specifies runtime fields for the datafeed search.

      API name: runtime_mappings

      Adds all entries of map to runtimeMappings.

    • runtimeMappings

      public final DatafeedConfig.Builder runtimeMappings(String key, RuntimeField value)
      Specifies runtime fields for the datafeed search.

      API name: runtime_mappings

      Adds an entry to runtimeMappings.

    • runtimeMappings

      public final DatafeedConfig.Builder runtimeMappings(String key, 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

      public final DatafeedConfig.Builder scriptFields(Map<String,ScriptField> map)
      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 to scriptFields.

    • scriptFields

      public final DatafeedConfig.Builder scriptFields(String key, ScriptField value)
      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(String key, 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

      public final DatafeedConfig.Builder scrollSize(@Nullable Integer value)
      The size parameter that is used in Elasticsearch searches when the datafeed does not use aggregations. The maximum value is the value of index.max_result_window, which is 10,000 by default.

      API name: scroll_size

    • self

      protected DatafeedConfig.Builder self()
      Specified by:
      self in class WithJsonObjectBuilderBase<DatafeedConfig.Builder>

    • build

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