Class GetDatafeedsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetDatafeedsRequest
Retrieves configuration information for datafeeds. You can get information
for multiple datafeeds in a single API request by using a comma-separated
list of datafeeds or a wildcard expression. You can get information for all
datafeeds by using
_all
, by specifying *
as the
<feed_id>
, or by omitting the
<feed_id>
. This API returns a maximum of 10,000 datafeeds.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class co.elastic.clients.elasticsearch._types.RequestBase
RequestBase.AbstractBuilder<BuilderT extends RequestBase.AbstractBuilder<BuilderT>>
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Endpoint<GetDatafeedsRequest,
GetDatafeedsResponse, ErrorResponse> Endpoint "ml.get_datafeeds
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Deprecated.final Boolean
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.Identifier for the datafeed.final Boolean
Indicates if certain fields should be removed from the configuration on retrieval.static GetDatafeedsRequest
Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
Endpoint "ml.get_datafeeds
".
-
-
Method Details
-
of
public static GetDatafeedsRequest of(Function<GetDatafeedsRequest.Builder, ObjectBuilder<GetDatafeedsRequest>> fn) -
allowNoDatafeeds
Deprecated.7.10.0 Useallow_no_match
instead.Whether to ignore if a wildcard expression matches no datafeeds. (This includes_all
string or when no datafeeds have been specified)API name:
allow_no_datafeeds
-
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
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
-
excludeGenerated
Indicates if certain fields should be removed from the configuration on retrieval. This allows the configuration to be in an acceptable format to be retrieved and then added to another cluster.API name:
exclude_generated
-
allow_no_match
instead.