Package co.elastic.clients.elasticsearch.ml

Class StopDatafeedRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.StopDatafeedRequest

All Implemented Interfaces:

JsonpSerializable

@JsonpDeserializable
public class StopDatafeedRequest
extends RequestBase
implements JsonpSerializable

Stops one or more datafeeds. A datafeed that is stopped ceases to retrieve data from Elasticsearch. A datafeed 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	StopDatafeedRequest.Builder	Builder for StopDatafeedRequest.

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<StopDatafeedRequest>	_DESERIALIZER	Json deserializer for StopDatafeedRequest
static final Endpoint<StopDatafeedRequest,StopDatafeedResponse,ErrorResponse>	_ENDPOINT	Endpoint "ml.stop_datafeed".

Method Summary

Modifier and Type	Method	Description
final Boolean	allowNoMatch()	Refer to the description for the allow_no_match query parameter.
final String	datafeedId()	Required - Identifier for the datafeed.
final Boolean	force()	Refer to the description for the force query parameter.
static StopDatafeedRequest	of(Function<StopDatafeedRequest.Builder,ObjectBuilder<StopDatafeedRequest>> 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	setupStopDatafeedRequestDeserializer(ObjectDeserializer<StopDatafeedRequest.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<StopDatafeedRequest> _DESERIALIZER

Json deserializer for StopDatafeedRequest

_ENDPOINT

public static final Endpoint<StopDatafeedRequest,StopDatafeedResponse,ErrorResponse> _ENDPOINT

Endpoint "ml.stop_datafeed".

Method Details

of

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

allowNoMatch

@Nullable
public final Boolean allowNoMatch()

Refer to the description for the allow_no_match query parameter.

API name: allow_no_match

datafeedId

public final String datafeedId()

Required - Identifier for the datafeed. You can stop multiple datafeeds in a single API request by using a comma-separated list of datafeeds or a wildcard expression. You can close all datafeeds by using _all or by specifying * as the identifier.

API name: datafeed_id

force

@Nullable
public final Boolean force()

Refer to the description for the force query parameter.

API name: force

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)

setupStopDatafeedRequestDeserializer

protected static void setupStopDatafeedRequestDeserializer(ObjectDeserializer<StopDatafeedRequest.Builder> op)