Package co.elastic.clients.elasticsearch.ml

Class OpenJobRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.OpenJobRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class OpenJobRequest
extends RequestBase
implements JsonpSerializable

Open anomaly detection jobs.

An anomaly detection job must be opened to be ready to receive and analyze data. It can be opened and closed multiple times throughout its lifecycle. When you open a new job, it starts with an empty model. When you open an existing job, the most recent model state is automatically loaded. The job is ready to resume its analysis from where it left off, once new data is received.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<OpenJobRequest>	_DESERIALIZER	Json deserializer for OpenJobRequest
static final Endpoint<OpenJobRequest,OpenJobResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.open_job".

Method Summary

Modifier and Type	Method	Description
final String	jobId()	Required - Identifier for the anomaly detection job.
static OpenJobRequest	of(Function<OpenJobRequest.Builder,ObjectBuilder<OpenJobRequest>> 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	setupOpenJobRequestDeserializer(ObjectDeserializer<OpenJobRequest.Builder> op)
final Time	timeout()	Refer to the description for the timeout query parameter.

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

Json deserializer for OpenJobRequest

_ENDPOINT

public static final Endpoint<OpenJobRequest,OpenJobResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.open_job".

Method Details

of

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

jobId

public final String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

timeout

@Nullable
public final Time timeout()

Refer to the description for the timeout query parameter.

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)

setupOpenJobRequestDeserializer

protected static void setupOpenJobRequestDeserializer(ObjectDeserializer<OpenJobRequest.Builder> op)