Package co.elastic.clients.elasticsearch.ml

Class ChunkingConfig

java.lang.Object

co.elastic.clients.elasticsearch.ml.ChunkingConfig

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class ChunkingConfig
extends Object
implements JsonpSerializable

See Also:

• API specification

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ChunkingConfig.Builder	Builder for ChunkingConfig.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ChunkingConfig>	_DESERIALIZER	Json deserializer for ChunkingConfig

Method Summary

Modifier and Type	Method	Description
final ChunkingMode	mode()	Required - If the mode is auto, the chunk size is dynamically calculated; this is the recommended value when the datafeed does not use aggregations.
static ChunkingConfig	of(Function<ChunkingConfig.Builder,ObjectBuilder<ChunkingConfig>> fn)
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupChunkingConfigDeserializer(ObjectDeserializer<ChunkingConfig.Builder> op)
final Time	timeSpan()	The time span that each search will be querying.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ChunkingConfig> _DESERIALIZER

Json deserializer for ChunkingConfig

Method Details

of

public static ChunkingConfig of(Function<ChunkingConfig.Builder,ObjectBuilder<ChunkingConfig>> fn)

mode

public final ChunkingMode mode()

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

@Nullable
public final Time timeSpan()

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

API name: time_span

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toString

public String toString()

Overrides:

toString in class Object

setupChunkingConfigDeserializer

protected static void setupChunkingConfigDeserializer(ObjectDeserializer<ChunkingConfig.Builder> op)