Class GetDatafeedStatsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetDatafeedStatsRequest
public class GetDatafeedStatsRequest extends RequestBase
Retrieves usage information for datafeeds. You can get statistics for
multiple datafeeds in a single API request by using a comma-separated list of
datafeeds or a wildcard expression. You can get statistics for all datafeeds
by using
_all
, by specifying *
as the
<feed_id>
, or by omitting the
<feed_id>
. If the datafeed is stopped, the only
information you receive is the datafeed_id
and the
state
. This API returns a maximum of 10,000 datafeeds.- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetDatafeedStatsRequest.Builder
Builder forGetDatafeedStatsRequest
.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<GetDatafeedStatsRequest,GetDatafeedStatsResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.get_datafeed_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 datafeeds that match. Contains the_all
string or no identifiers and there are no matches. Contains wildcard expressions and there are only partial matches.java.util.List<java.lang.String>
datafeedId()
Identifier for the datafeed.static GetDatafeedStatsRequest
of(java.util.function.Function<GetDatafeedStatsRequest.Builder,ObjectBuilder<GetDatafeedStatsRequest>> fn)
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<GetDatafeedStatsRequest,GetDatafeedStatsResponse,ErrorResponse> _ENDPOINTEndpoint "ml.get_datafeed_stats
".
-
-
Method Details
-
of
public static GetDatafeedStatsRequest of(java.util.function.Function<GetDatafeedStatsRequest.Builder,ObjectBuilder<GetDatafeedStatsRequest>> fn) -
allowNoMatch
@Nullable public final java.lang.Boolean allowNoMatch()Specifies what to do when the request:- Contains wildcard expressions and there are no datafeeds 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 emptydatafeeds
array when there are no matches and the subset of results when there are partial matches. If this parameter isfalse
, the request returns a404
status code when there are no matches or only partial matches.API name:
allow_no_match
-
datafeedId
public final java.util.List<java.lang.String> datafeedId()Identifier for the datafeed. It can be a datafeed identifier or a wildcard expression. If you do not specify one of these options, the API returns information about all datafeeds.API name:
datafeed_id
-