Class StartDataFrameAnalyticsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.StartDataFrameAnalyticsRequest
public class StartDataFrameAnalyticsRequest extends RequestBase
Starts a data frame analytics job. A data frame analytics job can be started
and stopped multiple times throughout its lifecycle. If the destination index
does not exist, it is created automatically the first time you start the data
frame analytics job. The
index.number_of_shards
and
index.number_of_replicas
settings for the destination index are
copied from the source index. If there are multiple source indices, the
destination index copies the highest setting values. The mappings for the
destination index are also copied from the source indices. If there are any
mapping conflicts, the job fails to start. If the destination index exists,
it is used as is. You can therefore set up the destination index in advance
with custom settings and mappings.- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
StartDataFrameAnalyticsRequest.Builder
Builder forStartDataFrameAnalyticsRequest
.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 Endpoint<StartDataFrameAnalyticsRequest,StartDataFrameAnalyticsResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.start_data_frame_analytics
". -
Method Summary
Modifier and Type Method Description java.lang.String
id()
Required - Identifier for the data frame analytics job.static StartDataFrameAnalyticsRequest
of(java.util.function.Function<StartDataFrameAnalyticsRequest.Builder,ObjectBuilder<StartDataFrameAnalyticsRequest>> fn)
Time
timeout()
Controls the amount of time to wait until the data frame analytics job starts.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
-
_ENDPOINT
public static final Endpoint<StartDataFrameAnalyticsRequest,StartDataFrameAnalyticsResponse,ErrorResponse> _ENDPOINTEndpoint "ml.start_data_frame_analytics
".
-
-
Method Details
-
of
public static StartDataFrameAnalyticsRequest of(java.util.function.Function<StartDataFrameAnalyticsRequest.Builder,ObjectBuilder<StartDataFrameAnalyticsRequest>> fn) -
id
public final java.lang.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
Controls the amount of time to wait until the data frame analytics job starts.API name:
timeout
-