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 forStopDatafeedRequest
.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<StopDatafeedRequest>
_DESERIALIZER
Json deserializer forStopDatafeedRequest
static Endpoint<StopDatafeedRequest,StopDatafeedResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.stop_datafeed
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoMatch()
Refer to the description for theallow_no_match
query parameter.java.lang.String
datafeedId()
Required - Identifier for the datafeed.java.lang.Boolean
force()
Refer to the description for theforce
query parameter.static StopDatafeedRequest
of(java.util.function.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)
Time
timeout()
Refer to the description for thetimeout
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
Json deserializer forStopDatafeedRequest
-
_ENDPOINT
Endpoint "ml.stop_datafeed
".
-
-
Method Details
-
of
public static StopDatafeedRequest of(java.util.function.Function<StopDatafeedRequest.Builder,ObjectBuilder<StopDatafeedRequest>> fn) -
allowNoMatch
@Nullable public final java.lang.Boolean allowNoMatch()Refer to the description for theallow_no_match
query parameter.API name:
allow_no_match
-
datafeedId
public final java.lang.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 java.lang.Boolean 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)
-