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
Reverts to a specific 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 forRevertModelSnapshotRequest
.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<RevertModelSnapshotRequest>
_DESERIALIZER
Json deserializer forRevertModelSnapshotRequest
static Endpoint<RevertModelSnapshotRequest,RevertModelSnapshotResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.revert_model_snapshot
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
deleteInterveningResults()
If true, deletes the results in the time period between the latest results and the time of the reverted snapshot.java.lang.String
jobId()
Required - Identifier for the anomaly detection job.static RevertModelSnapshotRequest
of(java.util.function.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)
java.lang.String
snapshotId()
Required - You can specifyempty
as the <snapshot_id>.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forRevertModelSnapshotRequest
-
_ENDPOINT
public static final Endpoint<RevertModelSnapshotRequest,RevertModelSnapshotResponse,ErrorResponse> _ENDPOINTEndpoint "ml.revert_model_snapshot
".
-
-
Method Details
-
of
public static RevertModelSnapshotRequest of(java.util.function.Function<RevertModelSnapshotRequest.Builder,ObjectBuilder<RevertModelSnapshotRequest>> fn) -
deleteInterveningResults
@Nullable public final java.lang.Boolean deleteInterveningResults()If true, deletes the results in the time period between the latest results and the time of the reverted snapshot. It also resets the model to accept records for this time period. If you choose not to delete intervening results when reverting a snapshot, the job will not accept input data that is older than the current time. If you want to resend data, then delete the intervening results.API name:
delete_intervening_results
-
jobId
public final java.lang.String jobId()Required - Identifier for the anomaly detection job.API name:
job_id
-
snapshotId
public final java.lang.String snapshotId()Required - You can specifyempty
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
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupRevertModelSnapshotRequestDeserializer
protected static void setupRevertModelSnapshotRequestDeserializer(ObjectDeserializer<RevertModelSnapshotRequest.Builder> op)
-