Package co.elastic.clients.elasticsearch.ml

Class StartDatafeedRequest

java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.StartDatafeedRequest
All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable
public class StartDatafeedRequest
extends RequestBase
implements JsonpSerializable
Starts one or more datafeeds.

A datafeed must be started in order to retrieve data from Elasticsearch. A datafeed can be started and stopped multiple times throughout its lifecycle.

Before you can start a datafeed, the anomaly detection job must be open. Otherwise, an error occurs.

If you restart a stopped datafeed, it continues processing input data from the next millisecond after it was stopped. If new data was indexed for that exact millisecond between stopping and starting, it will be ignored.

When Elasticsearch security features are enabled, your datafeed remembers which roles the last user to create or update it had at the time of creation or update and runs the query using those same roles. If you provided secondary authorization headers when you created or updated the datafeed, those credentials are used instead.

See Also:
API specification

  • Field Details

  • Method Details

    • of

      public static StartDatafeedRequest of​(java.util.function.Function<StartDatafeedRequest.Builder,​ObjectBuilder<StartDatafeedRequest>> fn)

    • datafeedId

      public final java.lang.String datafeedId()
      Required - A numerical character string that uniquely identifies the datafeed. 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: datafeed_id

    • end

      @Nullable public final Time end()
      Refer to the description for the end query parameter.

      API name: end

    • start

      @Nullable public final Time start()
      Refer to the description for the start query parameter.

      API name: start

    • 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)

    • setupStartDatafeedRequestDeserializer

      protected static void setupStartDatafeedRequestDeserializer​(ObjectDeserializer<StartDatafeedRequest.Builder> op)