Package co.elastic.clients.elasticsearch.ml

Class UpdateModelSnapshotRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.UpdateModelSnapshotRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class UpdateModelSnapshotRequest
extends RequestBase
implements JsonpSerializable

Update a snapshot. Updates certain properties of a snapshot.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<UpdateModelSnapshotRequest>	_DESERIALIZER	Json deserializer for UpdateModelSnapshotRequest
static final Endpoint<UpdateModelSnapshotRequest,UpdateModelSnapshotResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.update_model_snapshot".

Method Summary

Modifier and Type	Method	Description
final String	description()	A description of the model snapshot.
final String	jobId()	Required - Identifier for the anomaly detection job.
static UpdateModelSnapshotRequest	of(Function<UpdateModelSnapshotRequest.Builder,ObjectBuilder<UpdateModelSnapshotRequest>> fn)
final Boolean	retain()	If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days.
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	setupUpdateModelSnapshotRequestDeserializer(ObjectDeserializer<UpdateModelSnapshotRequest.Builder> op)
final String	snapshotId()	Required - Identifier for the model snapshot.

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

Json deserializer for UpdateModelSnapshotRequest

_ENDPOINT

public static final Endpoint<UpdateModelSnapshotRequest,UpdateModelSnapshotResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.update_model_snapshot".

Method Details

of

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

description

@Nullable
public final String description()

A description of the model snapshot.

API name: description

jobId

public final String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

retain

@Nullable
public final Boolean retain()

If true, this snapshot will not be deleted during automatic cleanup of snapshots older than model_snapshot_retention_days. However, this snapshot will be deleted when the job is deleted.

API name: retain

snapshotId

public final String snapshotId()

Required - Identifier for the model snapshot.

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)

setupUpdateModelSnapshotRequestDeserializer

protected static void setupUpdateModelSnapshotRequestDeserializer(ObjectDeserializer<UpdateModelSnapshotRequest.Builder> op)