Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.annotations

Class Annotation

java.lang.Object

org.elasticsearch.xpack.core.ml.annotations.Annotation

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class Annotation
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	Annotation.Builder
static enum	Annotation.Event
static enum	Annotation.Type

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	ANNOTATION
static final ParseField	BY_FIELD_NAME
static final ParseField	BY_FIELD_VALUE
static final ParseField	CREATE_TIME
static final ParseField	CREATE_USERNAME
static final ParseField	DETECTOR_INDEX
static final ParseField	END_TIMESTAMP
static final ParseField	EVENT
static final ParseField	MODIFIED_TIME
static final ParseField	MODIFIED_USERNAME
static final ParseField	OVER_FIELD_NAME
static final ParseField	OVER_FIELD_VALUE
static final ParseField	PARTITION_FIELD_NAME
static final ParseField	PARTITION_FIELD_VALUE
static final ParseField	RESULTS_FIELD	Result type is needed due to the fact that Annotation can be returned from C++ as an ML result.
static final ParseField	TIMESTAMP
static final ParseField	TYPE

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
Annotation(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
static Annotation	fromXContent(XContentParser parser, Void context)	Parses Annotation using a strict parser.
String	getAnnotation()
String	getByFieldName()
String	getByFieldValue()
Date	getCreateTime()
String	getCreateUsername()
Integer	getDetectorIndex()
Date	getEndTimestamp()
Annotation.Event	getEvent()
String	getJobId()
Date	getModifiedTime()
String	getModifiedUsername()
String	getOverFieldName()
String	getOverFieldValue()
String	getPartitionFieldName()
String	getPartitionFieldValue()
Date	getTimestamp()
Annotation.Type	getType()
int	hashCode()
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

Result type is needed due to the fact that Annotation can be returned from C++ as an ML result.

ANNOTATION

public static final ParseField ANNOTATION

CREATE_TIME

public static final ParseField CREATE_TIME

CREATE_USERNAME

public static final ParseField CREATE_USERNAME

TIMESTAMP

public static final ParseField TIMESTAMP

END_TIMESTAMP

public static final ParseField END_TIMESTAMP

MODIFIED_TIME

public static final ParseField MODIFIED_TIME

MODIFIED_USERNAME

public static final ParseField MODIFIED_USERNAME

TYPE

public static final ParseField TYPE

EVENT

public static final ParseField EVENT

DETECTOR_INDEX

public static final ParseField DETECTOR_INDEX

PARTITION_FIELD_NAME

public static final ParseField PARTITION_FIELD_NAME

PARTITION_FIELD_VALUE

public static final ParseField PARTITION_FIELD_VALUE

OVER_FIELD_NAME

public static final ParseField OVER_FIELD_NAME

OVER_FIELD_VALUE

public static final ParseField OVER_FIELD_VALUE

BY_FIELD_NAME

public static final ParseField BY_FIELD_NAME

BY_FIELD_VALUE

public static final ParseField BY_FIELD_VALUE

Constructor Details

Annotation

public Annotation(StreamInput in)
           throws IOException

Throws:

IOException

Method Details

fromXContent

public static Annotation fromXContent(XContentParser parser,
 Void context)

Parses Annotation using a strict parser.

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getAnnotation

public String getAnnotation()

getCreateTime

public Date getCreateTime()

getCreateUsername

public String getCreateUsername()

getTimestamp

public Date getTimestamp()

getEndTimestamp

public Date getEndTimestamp()

getJobId

public String getJobId()

getModifiedTime

public Date getModifiedTime()

getModifiedUsername

public String getModifiedUsername()

getType

public Annotation.Type getType()

getEvent

public Annotation.Event getEvent()

getDetectorIndex

public Integer getDetectorIndex()

getPartitionFieldName

public String getPartitionFieldName()

getPartitionFieldValue

public String getPartitionFieldValue()

getOverFieldName

public String getOverFieldName()

getOverFieldValue

public String getOverFieldValue()

getByFieldName

public String getByFieldName()

getByFieldValue

public String getByFieldValue()

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object