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
Forces any buffered data to be processed by the job. 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 classFlushJobRequest.BuilderBuilder forFlushJobRequest.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<FlushJobRequest>_DESERIALIZERJson deserializer forFlushJobRequeststatic Endpoint<FlushJobRequest,FlushJobResponse,ErrorResponse>_ENDPOINTEndpoint "ml.flush_job". -
Method Summary
Modifier and Type Method Description DateTimeadvanceTime()Refer to the description for theadvance_timequery parameter.java.lang.BooleancalcInterim()Refer to the description for thecalc_interimquery parameter.DateTimeend()Refer to the description for theendquery parameter.java.lang.StringjobId()Required - Identifier for the anomaly detection job.static FlushJobRequestof(java.util.function.Function<FlushJobRequest.Builder,ObjectBuilder<FlushJobRequest>> fn)voidserialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)Serialize this object to JSON.protected voidserializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)protected static voidsetupFlushJobRequestDeserializer(ObjectDeserializer<FlushJobRequest.Builder> op)DateTimeskipTime()Refer to the description for theskip_timequery parameter.DateTimestart()Refer to the description for thestartquery parameter.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forFlushJobRequest -
_ENDPOINT
Endpoint "ml.flush_job".
-
-
Method Details
-
of
public static FlushJobRequest of(java.util.function.Function<FlushJobRequest.Builder,ObjectBuilder<FlushJobRequest>> fn) -
advanceTime
Refer to the description for theadvance_timequery parameter.API name:
advance_time -
calcInterim
@Nullable public final java.lang.Boolean calcInterim()Refer to the description for thecalc_interimquery parameter.API name:
calc_interim -
end
Refer to the description for theendquery parameter.API name:
end -
jobId
public final java.lang.String jobId()Required - Identifier for the anomaly detection job.API name:
job_id -
skipTime
Refer to the description for theskip_timequery parameter.API name:
skip_time -
start
Refer to the description for thestartquery parameter.API name:
start -
serialize
Serialize this object to JSON.- Specified by:
serializein interfaceJsonpSerializable
-
serializeInternal
-
setupFlushJobRequestDeserializer
protected static void setupFlushJobRequestDeserializer(ObjectDeserializer<FlushJobRequest.Builder> op)
-