Package co.elastic.clients.elasticsearch.indices

Class DownsampleRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.indices.DownsampleRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DownsampleRequest
extends RequestBase
implements JsonpSerializable

Downsample an index.

Downsamples a time series (TSDS) index and reduces its size by keeping the last value or by pre-aggregating metrics:

• When running in aggregate mode, it pre-calculates and stores statistical summaries (min, max, sum, value_count and avg) for each metric field grouped by a configured time interval and their dimensions.
• When running in last_value mode, it keeps the last value for each metric in the configured interval and their dimensions.

For example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index. All documents within an hour interval are summarized and stored as a single document in the downsample index.

NOTE: Only indices in a time series data stream are supported. Neither field nor document level security can be defined on the source index. The source index must be read-only (index.blocks.write: true).

See Also:

• API specification

Nested Class Summary

Nested Classes

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

Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase

RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<DownsampleRequest>	_DESERIALIZER
static final Endpoint<DownsampleRequest,DownsampleResponse,ErrorResponse>	_ENDPOINT	Endpoint "indices.downsample".

Method Summary

Modifier and Type	Method	Description
final DownsampleConfig	config()	Required - Request body.
protected static JsonpDeserializer<DownsampleRequest>	createDownsampleRequestDeserializer()
final String	index()	Required - Name of the time series index to downsample.
static DownsampleRequest	of(Function<DownsampleRequest.Builder,ObjectBuilder<DownsampleRequest>> fn)
DownsampleRequest.Builder	rebuild()
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this value to JSON.
final String	targetIndex()	Required - Name of the index to create.

Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase

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<DownsampleRequest> _DESERIALIZER

_ENDPOINT

public static final Endpoint<DownsampleRequest,DownsampleResponse,ErrorResponse> _ENDPOINT

Endpoint "indices.downsample".

Method Details

of

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

index

public final String index()

Required - Name of the time series index to downsample.

API name: index

targetIndex

public final String targetIndex()

Required - Name of the index to create.

API name: target_index

config

public final DownsampleConfig config()

Required - Request body.

serialize

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

Serialize this value to JSON.

Specified by:

serialize in interface JsonpSerializable

rebuild

public DownsampleRequest.Builder rebuild()

Returns:

New DownsampleRequest.Builder initialized with field values of this instance

createDownsampleRequestDeserializer

protected static JsonpDeserializer<DownsampleRequest> createDownsampleRequestDeserializer()