Package co.elastic.clients.elasticsearch.ml

Class Datafeed.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

co.elastic.clients.util.WithJsonObjectBuilderBase<Datafeed.Builder>

co.elastic.clients.elasticsearch.ml.Datafeed.Builder

All Implemented Interfaces:

WithJson<Datafeed.Builder>, ObjectBuilder<Datafeed>

Enclosing class:

Datafeed

public static class Datafeed.Builder
extends WithJsonObjectBuilderBase<Datafeed.Builder>
implements ObjectBuilder<Datafeed>

Builder for Datafeed.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
final Datafeed.Builder	aggregations(String key, Aggregation value)	API name: aggregations
final Datafeed.Builder	aggregations(String key, AggregationVariant value)	API name: aggregations
final Datafeed.Builder	aggregations(String key, Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)	API name: aggregations
final Datafeed.Builder	aggregations(Map<String,Aggregation> map)	API name: aggregations
final Datafeed.Builder	authorization(DatafeedAuthorization value)	The security privileges that the datafeed uses to run its queries.
final Datafeed.Builder	authorization(Function<DatafeedAuthorization.Builder,ObjectBuilder<DatafeedAuthorization>> fn)	The security privileges that the datafeed uses to run its queries.
Datafeed	build()	Builds a Datafeed.
final Datafeed.Builder	chunkingConfig(ChunkingConfig value)	API name: chunking_config
final Datafeed.Builder	chunkingConfig(Function<ChunkingConfig.Builder,ObjectBuilder<ChunkingConfig>> fn)	API name: chunking_config
final Datafeed.Builder	datafeedId(String value)	Required - API name: datafeed_id
final Datafeed.Builder	delayedDataCheckConfig(DelayedDataCheckConfig value)	Required - API name: delayed_data_check_config
final Datafeed.Builder	delayedDataCheckConfig(Function<DelayedDataCheckConfig.Builder,ObjectBuilder<DelayedDataCheckConfig>> fn)	Required - API name: delayed_data_check_config
final Datafeed.Builder	frequency(Time value)	The interval at which scheduled queries are made while the datafeed runs in real time.
final Datafeed.Builder	frequency(Function<Time.Builder,ObjectBuilder<Time>> fn)	The interval at which scheduled queries are made while the datafeed runs in real time.
final Datafeed.Builder	indexes(String value, String... values)	API name: indexes
final Datafeed.Builder	indexes(List<String> list)	API name: indexes
final Datafeed.Builder	indices(String value, String... values)	Required - API name: indices
final Datafeed.Builder	indices(List<String> list)	Required - API name: indices
final Datafeed.Builder	indicesOptions(IndicesOptions value)	API name: indices_options
final Datafeed.Builder	indicesOptions(Function<IndicesOptions.Builder,ObjectBuilder<IndicesOptions>> fn)	API name: indices_options
final Datafeed.Builder	jobId(String value)	Required - API name: job_id
final Datafeed.Builder	maxEmptySearches(Integer value)	API name: max_empty_searches
final Datafeed.Builder	query(Query value)	Required - API name: query
final Datafeed.Builder	query(QueryVariant value)	Required - API name: query
final Datafeed.Builder	query(Function<Query.Builder,ObjectBuilder<Query>> fn)	Required - API name: query
final Datafeed.Builder	queryDelay(Time value)	API name: query_delay
final Datafeed.Builder	queryDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)	API name: query_delay
final Datafeed.Builder	runtimeMappings(String key, RuntimeField value)	API name: runtime_mappings
final Datafeed.Builder	runtimeMappings(String key, Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)	API name: runtime_mappings
final Datafeed.Builder	runtimeMappings(Map<String,RuntimeField> map)	API name: runtime_mappings
final Datafeed.Builder	scriptFields(String key, ScriptField value)	API name: script_fields
final Datafeed.Builder	scriptFields(String key, Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)	API name: script_fields
final Datafeed.Builder	scriptFields(Map<String,ScriptField> map)	API name: script_fields
final Datafeed.Builder	scrollSize(Integer value)	API name: scroll_size
protected Datafeed.Builder	self()

Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase

withJson

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

aggregations

public final Datafeed.Builder aggregations(Map<String,Aggregation> map)

API name: aggregations

Adds all entries of map to aggregations.

aggregations

public final Datafeed.Builder aggregations(String key,
 Aggregation value)

API name: aggregations

Adds an entry to aggregations.

aggregations

public final Datafeed.Builder aggregations(String key,
 AggregationVariant value)

API name: aggregations

Adds an entry to aggregations.

aggregations

public final Datafeed.Builder aggregations(String key,
 Function<Aggregation.Builder,ObjectBuilder<Aggregation>> fn)

API name: aggregations

Adds an entry to aggregations using a builder lambda.

authorization

public final Datafeed.Builder authorization(@Nullable
 DatafeedAuthorization value)

The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted.

API name: authorization

authorization

public final Datafeed.Builder authorization(Function<DatafeedAuthorization.Builder,ObjectBuilder<DatafeedAuthorization>> fn)

The security privileges that the datafeed uses to run its queries. If Elastic Stack security features were disabled at the time of the most recent update to the datafeed, this property is omitted.

API name: authorization

chunkingConfig

public final Datafeed.Builder chunkingConfig(@Nullable
 ChunkingConfig value)

API name: chunking_config

chunkingConfig

public final Datafeed.Builder chunkingConfig(Function<ChunkingConfig.Builder,ObjectBuilder<ChunkingConfig>> fn)

API name: chunking_config

datafeedId

public final Datafeed.Builder datafeedId(String value)

Required - API name: datafeed_id

frequency

public final Datafeed.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 Datafeed.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 Datafeed.Builder indices(List<String> list)

Required - API name: indices

Adds all elements of list to indices.

indices

public final Datafeed.Builder indices(String value,
 String... values)

Required - API name: indices

Adds one or more values to indices.

indexes

public final Datafeed.Builder indexes(List<String> list)

API name: indexes

Adds all elements of list to indexes.

indexes

public final Datafeed.Builder indexes(String value,
 String... values)

API name: indexes

Adds one or more values to indexes.

jobId

public final Datafeed.Builder jobId(String value)

Required - API name: job_id

maxEmptySearches

public final Datafeed.Builder maxEmptySearches(@Nullable
 Integer value)

API name: max_empty_searches

query

public final Datafeed.Builder query(Query value)

Required - API name: query

query

public final Datafeed.Builder query(Function<Query.Builder,ObjectBuilder<Query>> fn)

Required - API name: query

query

public final Datafeed.Builder query(QueryVariant value)

Required - API name: query

queryDelay

public final Datafeed.Builder queryDelay(@Nullable
 Time value)

API name: query_delay

queryDelay

public final Datafeed.Builder queryDelay(Function<Time.Builder,ObjectBuilder<Time>> fn)

API name: query_delay

scriptFields

public final Datafeed.Builder scriptFields(Map<String,ScriptField> map)

API name: script_fields

Adds all entries of map to scriptFields.

scriptFields

public final Datafeed.Builder scriptFields(String key,
 ScriptField value)

API name: script_fields

Adds an entry to scriptFields.

scriptFields

public final Datafeed.Builder scriptFields(String key,
 Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)

API name: script_fields

Adds an entry to scriptFields using a builder lambda.

scrollSize

public final Datafeed.Builder scrollSize(@Nullable
 Integer value)

API name: scroll_size

delayedDataCheckConfig

public final Datafeed.Builder delayedDataCheckConfig(DelayedDataCheckConfig value)

Required - API name: delayed_data_check_config

delayedDataCheckConfig

public final Datafeed.Builder delayedDataCheckConfig(Function<DelayedDataCheckConfig.Builder,ObjectBuilder<DelayedDataCheckConfig>> fn)

Required - API name: delayed_data_check_config

runtimeMappings

public final Datafeed.Builder runtimeMappings(Map<String,RuntimeField> map)

API name: runtime_mappings

Adds all entries of map to runtimeMappings.

runtimeMappings

public final Datafeed.Builder runtimeMappings(String key,
 RuntimeField value)

API name: runtime_mappings

Adds an entry to runtimeMappings.

runtimeMappings

public final Datafeed.Builder runtimeMappings(String key,
 Function<RuntimeField.Builder,ObjectBuilder<RuntimeField>> fn)

API name: runtime_mappings

Adds an entry to runtimeMappings using a builder lambda.

indicesOptions

public final Datafeed.Builder indicesOptions(@Nullable
 IndicesOptions value)

API name: indices_options

indicesOptions

public final Datafeed.Builder indicesOptions(Function<IndicesOptions.Builder,ObjectBuilder<IndicesOptions>> fn)

API name: indices_options

self

protected Datafeed.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<Datafeed.Builder>

build

public Datafeed build()

Builds a Datafeed.

Specified by:

build in interface ObjectBuilder<Datafeed>

Throws:

NullPointerException - if some of the required fields are null.