Class GetDataFrameAnalyticsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetDataFrameAnalyticsRequest
Retrieves configuration information for data frame analytics jobs. You can
get information for multiple data frame analytics jobs in a single API
request by using a comma-separated list of data frame analytics jobs or a
wildcard expression.
- 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 TypeFieldDescriptionEndpoint "ml.get_data_frame_analytics
". -
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
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.final Boolean
Indicates if certain fields should be removed from the configuration on retrieval.final Integer
from()
Skips the specified number of data frame analytics jobs.final String
id()
Identifier for the data frame analytics job.static GetDataFrameAnalyticsRequest
final Integer
size()
Specifies the maximum number of data frame analytics jobs to obtain.Methods inherited from class co.elastic.clients.elasticsearch._types.RequestBase
toString
-
Field Details
-
_ENDPOINT
public static final Endpoint<GetDataFrameAnalyticsRequest,GetDataFrameAnalyticsResponse, _ENDPOINTErrorResponse> Endpoint "ml.get_data_frame_analytics
".
-
-
Method Details
-
of
-
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
-
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
-
from
Skips the specified number of data frame analytics jobs.API name:
from
-
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
Specifies the maximum number of data frame analytics jobs to obtain.API name:
size
-