Package org.elasticsearch.client.ml
Class GetDataFrameAnalyticsRequest
java.lang.Object
org.elasticsearch.client.ml.GetDataFrameAnalyticsRequest
- All Implemented Interfaces:
Validatable
public class GetDataFrameAnalyticsRequest extends java.lang.Object implements Validatable
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
ALLOW_NO_MATCH
static java.lang.String
EXCLUDE_GENERATED
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
Constructors Constructor Description GetDataFrameAnalyticsRequest(java.lang.String... ids)
-
Method Summary
Modifier and Type Method Description boolean
equals(java.lang.Object o)
static GetDataFrameAnalyticsRequest
getAllDataFrameAnalyticsRequest()
Helper method to create a request that will get ALL Data Frame Analyticsjava.lang.Boolean
getAllowNoMatch()
java.lang.Boolean
getExcludeGenerated()
java.util.List<java.lang.String>
getIds()
PageParams
getPageParams()
int
hashCode()
GetDataFrameAnalyticsRequest
setAllowNoMatch(boolean allowNoMatch)
Whether to ignore if a wildcard expression matches no data frame analytics.void
setExcludeGenerated(boolean excludeGenerated)
Setting this flag to `true` removes certain fields from the configuration on retrieval.GetDataFrameAnalyticsRequest
setPageParams(PageParams pageParams)
java.util.Optional<ValidationException>
validate()
Perform validation.Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
ALLOW_NO_MATCH
public static final java.lang.String ALLOW_NO_MATCH- See Also:
- Constant Field Values
-
EXCLUDE_GENERATED
public static final java.lang.String EXCLUDE_GENERATED- See Also:
- Constant Field Values
-
-
Constructor Details
-
GetDataFrameAnalyticsRequest
public GetDataFrameAnalyticsRequest(java.lang.String... ids)
-
-
Method Details
-
getAllDataFrameAnalyticsRequest
Helper method to create a request that will get ALL Data Frame Analytics- Returns:
- new
GetDataFrameAnalyticsRequest
object for the id "_all"
-
getIds
public java.util.List<java.lang.String> getIds() -
getAllowNoMatch
public java.lang.Boolean getAllowNoMatch() -
setExcludeGenerated
public void setExcludeGenerated(boolean excludeGenerated)Setting this flag to `true` removes certain fields from the configuration on retrieval. This is useful when getting the configuration and wanting to put it in another cluster. Default value is false.- Parameters:
excludeGenerated
- Boolean value indicating if certain fields should be removed
-
getExcludeGenerated
public java.lang.Boolean getExcludeGenerated() -
setAllowNoMatch
Whether to ignore if a wildcard expression matches no data frame analytics.- Parameters:
allowNoMatch
- If this isfalse
, then an error is returned when a wildcard (or_all
) does not match any data frame analytics
-
getPageParams
-
setPageParams
-
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. AValidationException
that is not null is assumed to contain validation errors and will be thrown.- Specified by:
validate
in interfaceValidatable
- Returns:
- An
Optional
ValidationException
that contains a list of validation errors.
-
equals
public boolean equals(java.lang.Object o)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-