Package co.elastic.clients.elasticsearch.ml

Class ChunkingConfig.Builder

java.lang.Object

co.elastic.clients.util.ObjectBuilderBase

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

co.elastic.clients.elasticsearch.ml.ChunkingConfig.Builder

All Implemented Interfaces:

WithJson<ChunkingConfig.Builder>, ObjectBuilder<ChunkingConfig>

Enclosing class:

ChunkingConfig

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

Builder for ChunkingConfig.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ChunkingConfig	build()	Builds a ChunkingConfig.
final ChunkingConfig.Builder	mode(ChunkingMode value)	Required - If the mode is auto, the chunk size is dynamically calculated; this is the recommended value when the datafeed does not use aggregations.
protected ChunkingConfig.Builder	self()
final ChunkingConfig.Builder	timeSpan(Time value)	The time span that each search will be querying.
final ChunkingConfig.Builder	timeSpan(Function<Time.Builder,ObjectBuilder<Time>> fn)	The time span that each search will be querying.

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

mode

public final ChunkingConfig.Builder mode(ChunkingMode value)

Required - If the mode is auto, the chunk size is dynamically calculated; this is the recommended value when the datafeed does not use aggregations. If the mode is manual, chunking is applied according to the specified time_span; use this mode when the datafeed uses aggregations. If the mode is off, no chunking is applied.

API name: mode

timeSpan

public final ChunkingConfig.Builder timeSpan(@Nullable
 Time value)

The time span that each search will be querying. This setting is only applicable when the mode is set to manual.

API name: time_span

timeSpan

public final ChunkingConfig.Builder timeSpan(Function<Time.Builder,ObjectBuilder<Time>> fn)

The time span that each search will be querying. This setting is only applicable when the mode is set to manual.

API name: time_span

self

protected ChunkingConfig.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<ChunkingConfig.Builder>

build

public ChunkingConfig build()

Builds a ChunkingConfig.

Specified by:

build in interface ObjectBuilder<ChunkingConfig>

Throws:

NullPointerException - if some of the required fields are null.