Class StopDataFrameAnalyticsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<StopDataFrameAnalyticsRequest.Builder>
co.elastic.clients.elasticsearch.ml.StopDataFrameAnalyticsRequest.Builder
- All Implemented Interfaces:
WithJson<StopDataFrameAnalyticsRequest.Builder>
,ObjectBuilder<StopDataFrameAnalyticsRequest>
- Enclosing class:
- StopDataFrameAnalyticsRequest
public static class StopDataFrameAnalyticsRequest.Builder
extends RequestBase.AbstractBuilder<StopDataFrameAnalyticsRequest.Builder>
implements ObjectBuilder<StopDataFrameAnalyticsRequest>
Builder for
StopDataFrameAnalyticsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowNoMatch
(Boolean value) 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.build()
Builds aStopDataFrameAnalyticsRequest
.If true, the data frame analytics job is stopped forcefully.Required - Identifier for the data frame analytics job.protected StopDataFrameAnalyticsRequest.Builder
self()
Controls the amount of time to wait until the data frame analytics job stops.Controls the amount of time to wait until the data frame analytics job stops.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
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
If true, the data frame analytics job is stopped forcefully.API name:
force
-
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
-
timeout
public final StopDataFrameAnalyticsRequest.Builder timeout(Function<Time.Builder, ObjectBuilder<Time>> fn) Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.API name:
timeout
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<StopDataFrameAnalyticsRequest.Builder>
-
build
Builds aStopDataFrameAnalyticsRequest
.- Specified by:
build
in interfaceObjectBuilder<StopDataFrameAnalyticsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-