Package org.elasticsearch.client.ml

Class GetDataFrameAnalyticsRequest

java.lang.Object

org.elasticsearch.client.ml.GetDataFrameAnalyticsRequest

All Implemented Interfaces:

Validatable

public class GetDataFrameAnalyticsRequest
extends Object
implements Validatable

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	ALLOW_NO_MATCH

Fields inherited from interface org.elasticsearch.client.Validatable

EMPTY

Constructor Summary

Constructors

Constructor	Description
GetDataFrameAnalyticsRequest(String... ids)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static GetDataFrameAnalyticsRequest	getAllDataFrameAnalyticsRequest()	Helper method to create a request that will get ALL Data Frame Analytics
Boolean	getAllowNoMatch()
List<String>	getIds()
PageParams	getPageParams()
int	hashCode()
GetDataFrameAnalyticsRequest	setAllowNoMatch(boolean allowNoMatch)	Whether to ignore if a wildcard expression matches no data frame analytics.
GetDataFrameAnalyticsRequest	setPageParams(PageParams pageParams)
Optional<ValidationException>	validate()	Perform validation.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALLOW_NO_MATCH

public static final ParseField ALLOW_NO_MATCH

Constructor Detail

GetDataFrameAnalyticsRequest

public GetDataFrameAnalyticsRequest(String... ids)

Method Detail

getAllDataFrameAnalyticsRequest

public static GetDataFrameAnalyticsRequest getAllDataFrameAnalyticsRequest()

Helper method to create a request that will get ALL Data Frame Analytics

Returns:

new GetDataFrameAnalyticsRequest object for the id "_all"

getIds

public List<String> getIds()

getAllowNoMatch

public Boolean getAllowNoMatch()

setAllowNoMatch

public GetDataFrameAnalyticsRequest setAllowNoMatch(boolean allowNoMatch)

Whether to ignore if a wildcard expression matches no data frame analytics.

Parameters:

allowNoMatch - If this is false, then an error is returned when a wildcard (or _all) does not match any data frame analytics

getPageParams

public PageParams getPageParams()

setPageParams

public GetDataFrameAnalyticsRequest setPageParams(@Nullable
                                                  PageParams pageParams)

validate

public Optional<ValidationException> validate()

Description copied from interface: Validatable

Perform validation. This method does not have to be overridden in the event that no validation needs to be done, or the validation was done during object construction time. A ValidationException that is not null is assumed to contain validation errors and will be thrown.

Specified by:

validate in interface Validatable

Returns:

An Optional ValidationException that contains a list of validation errors.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object