Package co.elastic.clients.elasticsearch.ml

Class GetDataFrameAnalyticsRequest

java.lang.Object

co.elastic.clients.elasticsearch._types.RequestBase

co.elastic.clients.elasticsearch.ml.GetDataFrameAnalyticsRequest

All Implemented Interfaces:

ElasticsearchCommonRequest

public final class GetDataFrameAnalyticsRequest
extends RequestBase

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	GetDataFrameAnalyticsRequest.Builder	Builder for GetDataFrameAnalyticsRequest.

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,ElasticsearchError>	ENDPOINT	Endpoint "ml.get_data_frame_analytics".

Constructor Summary

Constructors

Constructor	Description
GetDataFrameAnalyticsRequest(GetDataFrameAnalyticsRequest.Builder builder)
GetDataFrameAnalyticsRequest(java.util.function.Function<GetDataFrameAnalyticsRequest.Builder,GetDataFrameAnalyticsRequest.Builder> fn)

Method Summary

Modifier and Type	Method	Description
java.lang.Boolean	allowNoMatch()	Whether to ignore if a wildcard expression matches no data frame analytics.
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.
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,ElasticsearchError> ENDPOINT

Endpoint "ml.get_data_frame_analytics".

Constructor Details

GetDataFrameAnalyticsRequest

public GetDataFrameAnalyticsRequest(GetDataFrameAnalyticsRequest.Builder builder)

GetDataFrameAnalyticsRequest

public GetDataFrameAnalyticsRequest(java.util.function.Function<GetDataFrameAnalyticsRequest.Builder,GetDataFrameAnalyticsRequest.Builder> fn)

Method Details

id

@Nullable
public 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

allowNoMatch

@Nullable
public java.lang.Boolean allowNoMatch()

Whether to ignore if a wildcard expression matches no data frame analytics. (This includes _all string or when no data frame analytics have been specified)

API name: allow_no_match

from

@Nullable
public java.lang.Integer from()

Skips the specified number of data frame analytics jobs.

API name: from

size

@Nullable
public java.lang.Integer size()

Specifies the maximum number of data frame analytics jobs to obtain.

API name: size

excludeGenerated

@Nullable
public 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