Package co.elastic.clients.elasticsearch.ml

Class StopDataFrameAnalyticsRequest.Builder

java.lang.Object

co.elastic.clients.elasticsearch.ml.StopDataFrameAnalyticsRequest.Builder

All Implemented Interfaces:

ObjectBuilder<StopDataFrameAnalyticsRequest>

Enclosing class:

StopDataFrameAnalyticsRequest

public static class StopDataFrameAnalyticsRequest.Builder
extends java.lang.Object
implements ObjectBuilder<StopDataFrameAnalyticsRequest>

Builder for StopDataFrameAnalyticsRequest.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
StopDataFrameAnalyticsRequest.Builder	allowNoMatch(java.lang.Boolean value)	Whether to ignore if a wildcard expression matches no data frame analytics.
StopDataFrameAnalyticsRequest	build()	Builds a StopDataFrameAnalyticsRequest.
StopDataFrameAnalyticsRequest.Builder	force(java.lang.Boolean value)	If true, the data frame analytics job is stopped forcefully.
StopDataFrameAnalyticsRequest.Builder	id(java.lang.String value)	Required - Identifier for the data frame analytics job.
StopDataFrameAnalyticsRequest.Builder	timeout(java.lang.String value)	Controls the amount of time to wait until the data frame analytics job stops.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

id

public StopDataFrameAnalyticsRequest.Builder id(java.lang.String value)

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

allowNoMatch

public StopDataFrameAnalyticsRequest.Builder allowNoMatch(@Nullable
java.lang.Boolean value)

Whether to ignore if a wildcard expression matches no data frame analytics. (This includes _all string or when no data frame analytics have been specified)

API name: allow_no_match

force

public StopDataFrameAnalyticsRequest.Builder force(@Nullable
java.lang.Boolean value)

If true, the data frame analytics job is stopped forcefully.

API name: force

timeout

public StopDataFrameAnalyticsRequest.Builder timeout(@Nullable
java.lang.String value)

Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.

API name: timeout

build

public StopDataFrameAnalyticsRequest build()

Builds a StopDataFrameAnalyticsRequest.

Specified by:

build in interface ObjectBuilder<StopDataFrameAnalyticsRequest>

Throws:

java.lang.NullPointerException - if some of the required fields are null.