StopDataFrameAnalyticsRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.StopDataFrameAnalyticsRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class StopDataFrameAnalyticsRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class StopDataFrameAnalyticsRequest.Builder
Builder for StopDataFrameAnalyticsRequest.

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,ElasticsearchError>`	`ENDPOINT`	Endpoint "`ml.stop_data_frame_analytics`".

Constructor Summary

Constructors
Constructor	Description
`StopDataFrameAnalyticsRequest(StopDataFrameAnalyticsRequest.Builder builder)`
`StopDataFrameAnalyticsRequest(java.util.function.Function<StopDataFrameAnalyticsRequest.Builder,StopDataFrameAnalyticsRequest.Builder> fn)`

Method Summary

Modifier and Type	Method	Description
`java.lang.Boolean`	`allowNoMatch()`	Whether to ignore if a wildcard expression matches no data frame analytics.
`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.
`java.lang.String`	`timeout()`	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

Field Details
- ENDPOINT
  
  public static final Endpoint<StopDataFrameAnalyticsRequest,StopDataFrameAnalyticsResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.stop_data_frame_analytics".
Constructor Details
- StopDataFrameAnalyticsRequest
  
  public StopDataFrameAnalyticsRequest(StopDataFrameAnalyticsRequest.Builder builder)
- StopDataFrameAnalyticsRequest
  
  public StopDataFrameAnalyticsRequest(java.util.function.Function<StopDataFrameAnalyticsRequest.Builder,StopDataFrameAnalyticsRequest.Builder> fn)
Method Details
- id
  
  public 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
- allowNoMatch
  
  @Nullable public java.lang.Boolean allowNoMatch()
  
  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
  
  @Nullable public java.lang.Boolean force()
  
  If true, the data frame analytics job is stopped forcefully.
  API name: force
- timeout
  
  @Nullable public java.lang.String timeout()
  
  Controls the amount of time to wait until the data frame analytics job stops. Defaults to 20 seconds.
  API name: timeout