Class GetDataFrameAnalyticsRequest
java.lang.Object
co.elastic.clients.elasticsearch._types.RequestBase
co.elastic.clients.elasticsearch.ml.GetDataFrameAnalyticsRequest
public class GetDataFrameAnalyticsRequest extends RequestBase
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:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
GetDataFrameAnalyticsRequest.Builder
Builder forGetDataFrameAnalyticsRequest
.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<GetDataFrameAnalyticsRequest,GetDataFrameAnalyticsResponse,ErrorResponse>
_ENDPOINT
Endpoint "ml.get_data_frame_analytics
". -
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.Boolean
excludeGenerated()
Indicates if certain fields should be removed from the configuration on retrieval.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 GetDataFrameAnalyticsRequest
of(java.util.function.Function<GetDataFrameAnalyticsRequest.Builder,ObjectBuilder<GetDataFrameAnalyticsRequest>> fn)
java.lang.Integer
size()
Specifies the maximum number of data frame analytics jobs to obtain.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<GetDataFrameAnalyticsRequest,GetDataFrameAnalyticsResponse,ErrorResponse> _ENDPOINTEndpoint "ml.get_data_frame_analytics
".
-
-
Method Details
-
of
public static GetDataFrameAnalyticsRequest of(java.util.function.Function<GetDataFrameAnalyticsRequest.Builder,ObjectBuilder<GetDataFrameAnalyticsRequest>> 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
-
excludeGenerated
@Nullable public final java.lang.Boolean 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
@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
-