Class GetDataFrameAnalyticsStatsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetDataFrameAnalyticsStatsRequest
public class GetDataFrameAnalyticsStatsRequest extends RequestBase
Retrieves usage information for data frame analytics jobs.
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetDataFrameAnalyticsStatsRequest.Builder
Builder forGetDataFrameAnalyticsStatsRequest
.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,ErrorResponse>
_ENDPOINT
Endpoint "ml.get_data_frame_analytics_stats
". -
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.Integer
from()
Skips the specified number of data frame analytics jobs.java.lang.String
id()
Identifier for the data frame analytics job.static GetDataFrameAnalyticsStatsRequest
of(java.util.function.Function<GetDataFrameAnalyticsStatsRequest.Builder,ObjectBuilder<GetDataFrameAnalyticsStatsRequest>> fn)
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 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<GetDataFrameAnalyticsStatsRequest,GetDataFrameAnalyticsStatsResponse,ErrorResponse> _ENDPOINTEndpoint "ml.get_data_frame_analytics_stats
".
-
-
Method Details
-
of
public static GetDataFrameAnalyticsStatsRequest of(java.util.function.Function<GetDataFrameAnalyticsStatsRequest.Builder,ObjectBuilder<GetDataFrameAnalyticsStatsRequest>> 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 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
-
from
@Nullable public final java.lang.Integer from()Skips the specified number of data frame analytics jobs.API name:
from
-
id
@Nullable public final 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
-
size
@Nullable public final java.lang.Integer size()Specifies the maximum number of data frame analytics jobs to obtain.API name:
size
-
verbose
@Nullable public final java.lang.Boolean verbose()Defines whether the stats response should be verbose.API name:
verbose
-