Package co.elastic.clients.elasticsearch.ml

Class RevertModelSnapshotRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.RevertModelSnapshotRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class RevertModelSnapshotRequest
extends RequestBase
implements JsonpSerializable

Revert to a snapshot. The machine learning features react quickly to anomalous input, learning new behaviors in data. Highly anomalous input increases the variance in the models whilst the system learns whether this is a new step-change in behavior or a one-off event. In the case where this anomalous input is known to be a one-off, then it might be appropriate to reset the model state to a time before this event. For example, you might consider reverting to a saved snapshot after Black Friday or a critical system failure.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<RevertModelSnapshotRequest>	_DESERIALIZER	Json deserializer for RevertModelSnapshotRequest
static final Endpoint<RevertModelSnapshotRequest,RevertModelSnapshotResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.revert_model_snapshot".

Method Summary

Modifier and Type	Method	Description
final Boolean	deleteInterveningResults()	Refer to the description for the delete_intervening_results query parameter.
final String	jobId()	Required - Identifier for the anomaly detection job.
static RevertModelSnapshotRequest	of(Function<RevertModelSnapshotRequest.Builder,ObjectBuilder<RevertModelSnapshotRequest>> 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	setupRevertModelSnapshotRequestDeserializer(ObjectDeserializer<RevertModelSnapshotRequest.Builder> op)
final String	snapshotId()	Required - You can specify empty as the <snapshot_id>.

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

Json deserializer for RevertModelSnapshotRequest

_ENDPOINT

public static final Endpoint<RevertModelSnapshotRequest,RevertModelSnapshotResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.revert_model_snapshot".

Method Details

of

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

deleteInterveningResults

@Nullable
public final Boolean deleteInterveningResults()

Refer to the description for the delete_intervening_results query parameter.

API name: delete_intervening_results

jobId

public final String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

snapshotId

public final String snapshotId()

Required - You can specify empty as the <snapshot_id>. Reverting to the empty snapshot means the anomaly detection job starts learning a new model from scratch when it is started.

API name: snapshot_id

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)

setupRevertModelSnapshotRequestDeserializer

protected static void setupRevertModelSnapshotRequestDeserializer(ObjectDeserializer<RevertModelSnapshotRequest.Builder> op)