Package org.elasticsearch.client.ml.job.config

Class MlFilter

java.lang.Object

org.elasticsearch.client.ml.job.config.MlFilter

All Implemented Interfaces:

ToXContent, ToXContentObject

public class MlFilter
extends java.lang.Object
implements 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

Modifier and Type	Class	Description
static class	MlFilter.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field	Description
static ParseField	DESCRIPTION
static ParseField	ID
static ParseField	ITEMS
static ObjectParser<MlFilter.Builder,java.lang.Void>	PARSER
static ParseField	RESULTS_FIELD
static ParseField	TYPE

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
static MlFilter.Builder	builder(java.lang.String filterId)	Creates a new Builder object for creating an MlFilter object
boolean	equals(java.lang.Object obj)
java.lang.String	getDescription()
java.lang.String	getId()
java.util.SortedSet<java.lang.String>	getItems()
int	hashCode()
XContentBuilder	toXContent(XContentBuilder builder, 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.common.xcontent.ToXContentObject

isFragment

Field Detail

TYPE

public static final ParseField TYPE

ID

public static final ParseField ID

DESCRIPTION

public static final ParseField DESCRIPTION

ITEMS

public static final ParseField ITEMS

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

PARSER

public static final ObjectParser<MlFilter.Builder,java.lang.Void> PARSER

Method Detail

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
                                  ToXContent.Params params)
                           throws java.io.IOException

Specified by:

toXContent in interface ToXContent

Throws:

java.io.IOException

getId

public java.lang.String getId()

getDescription

public java.lang.String getDescription()

getItems

public java.util.SortedSet<java.lang.String> getItems()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

builder

public static MlFilter.Builder builder(java.lang.String filterId)

Creates a new Builder object for creating an MlFilter object

Parameters:

filterId - The ID of the filter to create