Class MlFilter
java.lang.Object
org.elasticsearch.client.ml.job.config.MlFilter
- All Implemented Interfaces:
org.elasticsearch.xcontent.ToXContent
,org.elasticsearch.xcontent.ToXContentObject
An MlFilter Object
A filter contains a list of strings.
It can be used by one or more jobs.
Specifically, filters are referenced in the custom_rules property of detector configuration objects.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
org.elasticsearch.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.xcontent.ToXContent.MapParams, org.elasticsearch.xcontent.ToXContent.Params
-
Field Summary
Modifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ObjectParser<MlFilter.Builder,
Void> static final org.elasticsearch.xcontent.ParseField
static final org.elasticsearch.xcontent.ParseField
Fields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY_PARAMS
-
Method Summary
Modifier and TypeMethodDescriptionstatic MlFilter.Builder
Creates a new Builder object for creating an MlFilter objectboolean
getId()
getItems()
int
hashCode()
org.elasticsearch.xcontent.XContentBuilder
toXContent
(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
TYPE
public static final org.elasticsearch.xcontent.ParseField TYPE -
ID
public static final org.elasticsearch.xcontent.ParseField ID -
DESCRIPTION
public static final org.elasticsearch.xcontent.ParseField DESCRIPTION -
ITEMS
public static final org.elasticsearch.xcontent.ParseField ITEMS -
RESULTS_FIELD
public static final org.elasticsearch.xcontent.ParseField RESULTS_FIELD -
PARSER
-
-
Method Details
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContent
in interfaceorg.elasticsearch.xcontent.ToXContent
- Throws:
IOException
-
getId
-
getDescription
-
getItems
-
equals
-
hashCode
public int hashCode() -
builder
Creates a new Builder object for creating an MlFilter object- Parameters:
filterId
- The ID of the filter to create
-