Class StopDataFrameAnalyticsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.StopDataFrameAnalyticsRequest
public class StopDataFrameAnalyticsRequest extends RequestBase
Stops one or more data frame analytics jobs. A data frame analytics job 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
StopDataFrameAnalyticsRequest.Builder
Builder forStopDataFrameAnalyticsRequest
.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<StopDataFrameAnalyticsRequest,StopDataFrameAnalyticsResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.stop_data_frame_analytics
". -
Method Summary
Modifier and Type Method Description java.lang.Boolean
allowNoMatch()
Specifies what to do when the request: Contains wildcard expressions and there are no data frame analytics jobs that match. Contains the _all string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.java.lang.Boolean
force()
If true, the data frame analytics job is stopped forcefully.java.lang.String
id()
Required - Identifier for the data frame analytics job.static StopDataFrameAnalyticsRequest
of(java.util.function.Function<StopDataFrameAnalyticsRequest.Builder,ObjectBuilder<StopDataFrameAnalyticsRequest>> fn)
Time
timeout()
Controls the amount of time to wait until the data frame analytics job stops.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<StopDataFrameAnalyticsRequest,StopDataFrameAnalyticsResponse,ErrorResponse> _ENDPOINTEndpoint "ml.stop_data_frame_analytics
".
-
-
Method Details
-
of
public static StopDataFrameAnalyticsRequest of(java.util.function.Function<StopDataFrameAnalyticsRequest.Builder,ObjectBuilder<StopDataFrameAnalyticsRequest>> fn) -
allowNoMatch
@Nullable public final java.lang.Boolean allowNoMatch()Specifies what to do when the request:- Contains wildcard expressions and there are no data frame analytics jobs that match.
- Contains the _all string or no identifiers and there are no matches.
- Contains wildcard expressions and there are only partial matches.
The default value is true, which returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is false, the request returns a 404 status code when there are no matches or only partial matches.
API name:
allow_no_match
-
force
@Nullable public final java.lang.Boolean force()If true, the data frame analytics job is stopped forcefully.API name:
force
-
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 stops. Defaults to 20 seconds.API name:
timeout
-