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:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final JsonpDeserializer<StopDatafeedRequest>
Json deserializer forStopDatafeedRequest
static final Endpoint<StopDatafeedRequest,
StopDatafeedResponse, ErrorResponse> Endpoint "ml.stop_datafeed
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Refer to the description for theallow_no_match
query parameter.final String
Required - Identifier for the datafeed.final Boolean
force()
Refer to the description for theforce
query parameter.static StopDatafeedRequest
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
final Time
timeout()
Refer to the description for thetimeout
query parameter.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_DESERIALIZER
Json deserializer forStopDatafeedRequest
-
_ENDPOINT
Endpoint "ml.stop_datafeed
".
-
-
Method Details
-
of
public static StopDatafeedRequest of(Function<StopDatafeedRequest.Builder, ObjectBuilder<StopDatafeedRequest>> fn) -
allowNoMatch
Refer to the description for theallow_no_match
query parameter.API name:
allow_no_match
-
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
Refer to the description for theforce
query parameter.API name:
force
-
timeout
Refer to the description for thetimeout
query parameter.API name:
timeout
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupStopDatafeedRequestDeserializer
protected static void setupStopDatafeedRequestDeserializer(ObjectDeserializer<StopDatafeedRequest.Builder> op)
-