Package co.elastic.clients.elasticsearch.ml

Class GetModelSnapshotsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetModelSnapshotsRequest

All Implemented Interfaces:

ElasticsearchCommonRequest, JsonpSerializable

@JsonpDeserializable
public final class GetModelSnapshotsRequest
extends RequestBase
implements JsonpSerializable

Nested Class Summary

Nested Classes

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

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<GetModelSnapshotsRequest>	_DESERIALIZER	Json deserializer for GetModelSnapshotsRequest
static Endpoint<GetModelSnapshotsRequest,GetModelSnapshotsResponse,ElasticsearchError>	ENDPOINT	Endpoint "ml.get_model_snapshots".

Constructor Summary

Constructors

Constructor	Description
GetModelSnapshotsRequest(GetModelSnapshotsRequest.Builder builder)
GetModelSnapshotsRequest(java.util.function.Function<GetModelSnapshotsRequest.Builder,GetModelSnapshotsRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	desc()	If true, the results are sorted in descending order.
java.lang.String	end()	API name: end
java.lang.Integer	from()	Skips the specified number of snapshots.
java.lang.String	jobId()	Required - Identifier for the anomaly detection job.
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	setupGetModelSnapshotsRequestDeserializer(DelegatingDeserializer<GetModelSnapshotsRequest.Builder> op)
java.lang.Integer	size()	Specifies the maximum number of snapshots to obtain.
java.lang.String	snapshotId()	A numerical character string that uniquely identifies the model snapshot.
java.lang.String	sort()	Specifies the sort field for the requested snapshots.
java.lang.String	start()	API name: start

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

_DESERIALIZER

public static final JsonpDeserializer<GetModelSnapshotsRequest> _DESERIALIZER

Json deserializer for GetModelSnapshotsRequest

ENDPOINT

public static final Endpoint<GetModelSnapshotsRequest,GetModelSnapshotsResponse,ElasticsearchError> ENDPOINT

Endpoint "ml.get_model_snapshots".

Constructor Details

GetModelSnapshotsRequest

public GetModelSnapshotsRequest(GetModelSnapshotsRequest.Builder builder)

GetModelSnapshotsRequest

public GetModelSnapshotsRequest(java.util.function.Function<GetModelSnapshotsRequest.Builder,GetModelSnapshotsRequest.Builder> fn)

Method Details

jobId

public java.lang.String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

snapshotId

@Nullable
public java.lang.String snapshotId()

A numerical character string that uniquely identifies the model snapshot.

API name: snapshot_id

desc

@Nullable
public java.lang.Boolean desc()

If true, the results are sorted in descending order.

API name: desc

from

@Nullable
public java.lang.Integer from()

Skips the specified number of snapshots.

API name: from

size

@Nullable
public java.lang.Integer size()

Specifies the maximum number of snapshots to obtain.

API name: size

sort

@Nullable
public java.lang.String sort()

Specifies the sort field for the requested snapshots. By default, the snapshots are sorted by their timestamp.

API name: sort

start

@Nullable
public java.lang.String start()

API name: start

end

@Nullable
public java.lang.String end()

API name: end

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)

setupGetModelSnapshotsRequestDeserializer

protected static void setupGetModelSnapshotsRequestDeserializer(DelegatingDeserializer<GetModelSnapshotsRequest.Builder> op)