Package co.elastic.clients.elasticsearch.ml

Class DeleteExpiredDataRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.DeleteExpiredDataRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class DeleteExpiredDataRequest
extends RequestBase
implements JsonpSerializable

Deletes expired and unused machine learning data. Deletes all job results, model snapshots and forecast data that have exceeded their retention days period. Machine learning state documents that are not associated with any job are also deleted. You can limit the request to a single or set of anomaly detection jobs by using a job identifier, a group name, a comma-separated list of jobs, or a wildcard expression. You can delete expired data for all anomaly detection jobs by using _all, by specifying * as the <job_id>, or by omitting the <job_id>.

See Also:

API specification

Nested Class Summary

Nested Classes

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

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 JsonpDeserializer<DeleteExpiredDataRequest>	_DESERIALIZER	Json deserializer for DeleteExpiredDataRequest
static Endpoint<DeleteExpiredDataRequest,DeleteExpiredDataResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.delete_expired_data".

Method Summary

Modifier and Type	Method	Description
java.lang.String	jobId()	Identifier for an anomaly detection job.
static DeleteExpiredDataRequest	of(java.util.function.Function<DeleteExpiredDataRequest.Builder,ObjectBuilder<DeleteExpiredDataRequest>> fn)
java.lang.Float	requestsPerSecond()	The desired requests per second for the deletion processes.
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	setupDeleteExpiredDataRequestDeserializer(ObjectDeserializer<DeleteExpiredDataRequest.Builder> op)
Time	timeout()	How long can the underlying delete processes run until they are canceled.

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

Json deserializer for DeleteExpiredDataRequest

_ENDPOINT

public static final Endpoint<DeleteExpiredDataRequest,DeleteExpiredDataResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.delete_expired_data".

Method Details

of

public static DeleteExpiredDataRequest of(java.util.function.Function<DeleteExpiredDataRequest.Builder,ObjectBuilder<DeleteExpiredDataRequest>> fn)

jobId

@Nullable
public final java.lang.String jobId()

Identifier for an anomaly detection job. It can be a job identifier, a group name, or a wildcard expression.

API name: job_id

requestsPerSecond

@Nullable
public final java.lang.Float requestsPerSecond()

The desired requests per second for the deletion processes. The default behavior is no throttling.

API name: requests_per_second

timeout

@Nullable
public final Time timeout()

How long can the underlying delete processes run until they are canceled.

API name: timeout

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)

setupDeleteExpiredDataRequestDeserializer

protected static void setupDeleteExpiredDataRequestDeserializer(ObjectDeserializer<DeleteExpiredDataRequest.Builder> op)