Package org.elasticsearch.client.ml
Class GetDataFrameAnalyticsRequest
java.lang.Object
org.elasticsearch.client.ml.GetDataFrameAnalyticsRequest
- All Implemented Interfaces:
Validatable
-
Field Summary
Fields inherited from interface org.elasticsearch.client.Validatable
EMPTY
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
static GetDataFrameAnalyticsRequest
Helper method to create a request that will get ALL Data Frame AnalyticsgetIds()
int
hashCode()
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.setPageParams
(PageParams pageParams) validate()
Perform validation.
-
Field Details
-
ALLOW_NO_MATCH
- See Also:
-
EXCLUDE_GENERATED
- See Also:
-
-
Constructor Details
-
GetDataFrameAnalyticsRequest
-
-
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
-
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
-
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
-
hashCode
public int hashCode()
-