Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.job.results

Class CategoryDefinition

java.lang.Object

org.elasticsearch.xpack.core.ml.job.results.CategoryDefinition

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class CategoryDefinition
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ParseField	CATEGORY_ID
static final ParseField	EXAMPLES
static final ParseField	GROK_PATTERN
static final ConstructingObjectParser<CategoryDefinition,Void>	LENIENT_PARSER
static final ParseField	MAX_MATCHING_LENGTH
static final ParseField	MLCATEGORY
static final ParseField	NUM_MATCHES
static final ParseField	PARTITION_FIELD_NAME
static final ParseField	PARTITION_FIELD_VALUE
static final ParseField	PREFERRED_TO_CATEGORIES
static final ParseField	REGEX
static final ParseField	RESULTS_FIELD
static final ConstructingObjectParser<CategoryDefinition,Void>	STRICT_PARSER
static final ParseField	TERMS
static final ParseField	TYPE	Legacy type, now used only as a discriminant in the document ID

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
CategoryDefinition(String jobId)
CategoryDefinition(StreamInput in)

Method Summary

Modifier and Type	Method	Description
void	addExample(String example)
boolean	equals(Object other)
long	getCategoryId()
List<String>	getExamples()
String	getGrokPattern()
String	getId()
String	getJobId()
long	getMaxMatchingLength()
long	getNumMatches()
String	getPartitionFieldName()
String	getPartitionFieldValue()
long[]	getPreferredToCategories()
String	getRegex()
String	getTerms()
int	hashCode()
void	setCategoryId(long categoryId)
void	setExamples(Collection<String> examples)
void	setGrokPattern(String grokPattern)
void	setMaxMatchingLength(long maxMatchingLength)
void	setNumMatches(long numMatches)
void	setPartitionFieldName(String partitionFieldName)
void	setPartitionFieldValue(String partitionFieldValue)
void	setPreferredToCategories(long[] preferredToCategories)
void	setRegex(String regex)
void	setTerms(String terms)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

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 ParseField TYPE

Legacy type, now used only as a discriminant in the document ID

CATEGORY_ID

public static final ParseField CATEGORY_ID

PARTITION_FIELD_NAME

public static final ParseField PARTITION_FIELD_NAME

PARTITION_FIELD_VALUE

public static final ParseField PARTITION_FIELD_VALUE

TERMS

public static final ParseField TERMS

REGEX

public static final ParseField REGEX

MAX_MATCHING_LENGTH

public static final ParseField MAX_MATCHING_LENGTH

EXAMPLES

public static final ParseField EXAMPLES

GROK_PATTERN

public static final ParseField GROK_PATTERN

NUM_MATCHES

public static final ParseField NUM_MATCHES

PREFERRED_TO_CATEGORIES

public static final ParseField PREFERRED_TO_CATEGORIES

MLCATEGORY

public static final ParseField MLCATEGORY

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

STRICT_PARSER

public static final ConstructingObjectParser<CategoryDefinition,Void> STRICT_PARSER

LENIENT_PARSER

public static final ConstructingObjectParser<CategoryDefinition,Void> LENIENT_PARSER

Constructor Details

CategoryDefinition

public CategoryDefinition(String jobId)

CategoryDefinition

public CategoryDefinition(StreamInput in)
                   throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getJobId

public String getJobId()

getId

public String getId()

getCategoryId

public long getCategoryId()

setCategoryId

public void setCategoryId(long categoryId)

getPartitionFieldName

public String getPartitionFieldName()

setPartitionFieldName

public void setPartitionFieldName(String partitionFieldName)

getPartitionFieldValue

public String getPartitionFieldValue()

setPartitionFieldValue

public void setPartitionFieldValue(String partitionFieldValue)

getTerms

public String getTerms()

setTerms

public void setTerms(String terms)

getRegex

public String getRegex()

setRegex

public void setRegex(String regex)

getMaxMatchingLength

public long getMaxMatchingLength()

setMaxMatchingLength

public void setMaxMatchingLength(long maxMatchingLength)

getExamples

public List<String> getExamples()

setExamples

public void setExamples(Collection<String> examples)

addExample

public void addExample(String example)

getGrokPattern

public String getGrokPattern()

setGrokPattern

public void setGrokPattern(String grokPattern)

getPreferredToCategories

public long[] getPreferredToCategories()

setPreferredToCategories

public void setPreferredToCategories(long[] preferredToCategories)

getNumMatches

public long getNumMatches()

setNumMatches

public void setNumMatches(long numMatches)

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object