GetDataFrameAnalyticsStatsRequest (java-client 7.15.1 API)

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetDataFrameAnalyticsStatsRequest

All Implemented Interfaces:: ElasticsearchCommonRequest

public final class GetDataFrameAnalyticsStatsRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type Class Description

static class GetDataFrameAnalyticsStatsRequest.Builder
Builder for GetDataFrameAnalyticsStatsRequest.

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

Constructor Summary

Constructors
Constructor	Description
`GetDataFrameAnalyticsStatsRequest(GetDataFrameAnalyticsStatsRequest.Builder builder)`
`GetDataFrameAnalyticsStatsRequest(java.util.function.Function<GetDataFrameAnalyticsStatsRequest.Builder,GetDataFrameAnalyticsStatsRequest.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.Integer`	`from()`	Skips the specified number of data frame analytics jobs.
`java.lang.String`	`id()`	Identifier for the data frame analytics job.
`java.lang.Integer`	`size()`	Specifies the maximum number of data frame analytics jobs to obtain.
`java.lang.Boolean`	`verbose()`	Defines whether the stats response should be verbose.

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<GetDataFrameAnalyticsStatsRequest,GetDataFrameAnalyticsStatsResponse,ElasticsearchError> ENDPOINT
  
  Endpoint "ml.get_data_frame_analytics_stats".
Constructor Details
- GetDataFrameAnalyticsStatsRequest
  
  public GetDataFrameAnalyticsStatsRequest(GetDataFrameAnalyticsStatsRequest.Builder builder)
- GetDataFrameAnalyticsStatsRequest
  
  public GetDataFrameAnalyticsStatsRequest(java.util.function.Function<GetDataFrameAnalyticsStatsRequest.Builder,GetDataFrameAnalyticsStatsRequest.Builder> fn)
Method Details
- id
  
  @Nullable public java.lang.String id()
  
  Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.
  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
- from
  
  @Nullable public java.lang.Integer from()
  
  Skips the specified number of data frame analytics jobs.
  API name: from
- size
  
  @Nullable public java.lang.Integer size()
  
  Specifies the maximum number of data frame analytics jobs to obtain.
  API name: size
- verbose
  
  @Nullable public java.lang.Boolean verbose()
  
  Defines whether the stats response should be verbose.
  API name: verbose