Package co.elastic.clients.elasticsearch.ml

Class StopDataFrameAnalyticsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.StopDataFrameAnalyticsRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class StopDataFrameAnalyticsRequest
extends RequestBase
implements JsonpSerializable

Stop data frame analytics jobs.

A data frame analytics job can be started and stopped multiple times throughout its lifecycle.

See Also:

• API specification

Nested Class Summary

Nested Classes

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

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<StopDataFrameAnalyticsRequest>	_DESERIALIZER	Json deserializer for StopDataFrameAnalyticsRequest
static final Endpoint<StopDataFrameAnalyticsRequest,StopDataFrameAnalyticsResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.stop_data_frame_analytics".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoMatch()	Specifies what to do when the request: Contains wildcard expressions and there are no data frame analytics jobs that match. Contains the _all string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.
final Boolean	force()	If true, the data frame analytics job is stopped forcefully.
final String	id()	Required - Identifier for the data frame analytics job.
static StopDataFrameAnalyticsRequest	of(Function<StopDataFrameAnalyticsRequest.Builder,ObjectBuilder<StopDataFrameAnalyticsRequest>> fn)
StopDataFrameAnalyticsRequest.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	setupStopDataFrameAnalyticsRequestDeserializer(ObjectDeserializer<StopDataFrameAnalyticsRequest.Builder> op)
final Time	timeout()	Controls the amount of time to wait until the data frame analytics job stops.

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

Json deserializer for StopDataFrameAnalyticsRequest

_ENDPOINT

public static final Endpoint<StopDataFrameAnalyticsRequest,StopDataFrameAnalyticsResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.stop_data_frame_analytics".

Method Details

of

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

allowNoMatch

@Nullable
public final Boolean allowNoMatch()

Specifies what to do when the request:

1. Contains wildcard expressions and there are no data frame analytics jobs that match.
2. Contains the _all string or no identifiers and there are no matches.
3. Contains wildcard expressions and there are only partial matches.

The default value is true, which returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.

API name: allow_no_match

force

@Nullable
public final Boolean force()

If true, the data frame analytics job is stopped forcefully.

API name: force

id

public final String id()

Required - Identifier for the data frame analytics job. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It must start and end with alphanumeric characters.

API name: id

timeout

@Nullable
public final Time timeout()

Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.

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)

rebuild

public StopDataFrameAnalyticsRequest.Builder rebuild()

Returns:

New StopDataFrameAnalyticsRequest.Builder initialized with field values of this instance

setupStopDataFrameAnalyticsRequestDeserializer

protected static void setupStopDataFrameAnalyticsRequestDeserializer(ObjectDeserializer<StopDataFrameAnalyticsRequest.Builder> op)