Package co.elastic.clients.elasticsearch.ml

Class FlushJobRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.FlushJobRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class FlushJobRequest
extends RequestBase
implements JsonpSerializable

Force buffered data to be processed. The flush jobs API is only applicable when sending data for analysis using the post data API. Depending on the content of the buffer, then it might additionally calculate new results. Both flush and close operations are similar, however the flush is more efficient if you are expecting to send more data for analysis. When flushing, the job remains open and is available to continue analyzing data. A close operation additionally prunes and persists the model state to disk and the job must be opened again before analyzing further data.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<FlushJobRequest>	_DESERIALIZER	Json deserializer for FlushJobRequest
static final Endpoint<FlushJobRequest,FlushJobResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.flush_job".

Method Summary

Modifier and Type	Method	Description
final DateTime	advanceTime()	Refer to the description for the advance_time query parameter.
final Boolean	calcInterim()	Refer to the description for the calc_interim query parameter.
final DateTime	end()	Refer to the description for the end query parameter.
final String	jobId()	Required - Identifier for the anomaly detection job.
static FlushJobRequest	of(Function<FlushJobRequest.Builder,ObjectBuilder<FlushJobRequest>> fn)
FlushJobRequest.Builder	rebuild()
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	setupFlushJobRequestDeserializer(ObjectDeserializer<FlushJobRequest.Builder> op)
final DateTime	skipTime()	Refer to the description for the skip_time query parameter.
final DateTime	start()	Refer to the description for the start 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<FlushJobRequest> _DESERIALIZER

Json deserializer for FlushJobRequest

_ENDPOINT

public static final Endpoint<FlushJobRequest,FlushJobResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.flush_job".

Method Details

of

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

advanceTime

@Nullable
public final DateTime advanceTime()

Refer to the description for the advance_time query parameter.

API name: advance_time

calcInterim

@Nullable
public final Boolean calcInterim()

Refer to the description for the calc_interim query parameter.

API name: calc_interim

end

@Nullable
public final DateTime end()

Refer to the description for the end query parameter.

API name: end

jobId

public final String jobId()

Required - Identifier for the anomaly detection job.

API name: job_id

skipTime

@Nullable
public final DateTime skipTime()

Refer to the description for the skip_time query parameter.

API name: skip_time

start

@Nullable
public final DateTime start()

Refer to the description for the start query parameter.

API name: start

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)

rebuild

public FlushJobRequest.Builder rebuild()

Returns:

New FlushJobRequest.Builder initialized with field values of this instance

setupFlushJobRequestDeserializer

protected static void setupFlushJobRequestDeserializer(ObjectDeserializer<FlushJobRequest.Builder> op)