ChunkingConfig (java-client 7.16.3 API)

java.lang.Object

co.elastic.clients.elasticsearch.ml.ChunkingConfig

All Implemented Interfaces:: JsonpSerializable

@JsonpDeserializable
public class ChunkingConfig
extends java.lang.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 JsonpDeserializer<ChunkingConfig> _DESERIALIZER
Json deserializer for ChunkingConfig

Method Summary

Modifier and Type	Method	Description
`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(java.util.function.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)`
`Time`	`timeSpan()`	The time span that each search will be querying.

Methods inherited from class java.lang.Object

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

Field Details
- _DESERIALIZER
  
  public static final JsonpDeserializer<ChunkingConfig> _DESERIALIZER
  
  Json deserializer for ChunkingConfig
Method Details
- of
  
  public static ChunkingConfig of(java.util.function.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 only applicable 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)
- setupChunkingConfigDeserializer
  
  protected static void setupChunkingConfigDeserializer(ObjectDeserializer<ChunkingConfig.Builder> op)