Package org.elasticsearch.client.ml.job.results

Class Bucket

java.lang.Object

org.elasticsearch.client.ml.job.results.Bucket

All Implemented Interfaces:

ToXContent, ToXContentObject

public class Bucket
extends Object
implements ToXContentObject

Bucket Result POJO

Nested Class Summary

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	ANOMALY_SCORE
static ParseField	BUCKET_INFLUENCERS
static ParseField	BUCKET_SPAN
static ParseField	EVENT_COUNT
static ParseField	INITIAL_ANOMALY_SCORE
static ConstructingObjectParser<Bucket,Void>	PARSER
static ParseField	PROCESSING_TIME_MS
static ParseField	RECORDS
static ParseField	RESULT_TYPE_FIELD
static String	RESULT_TYPE_VALUE	Result type
static ParseField	RESULTS_FIELD
static ParseField	SCHEDULED_EVENTS

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

EMPTY_PARAMS

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)	Compare all the fields and embedded anomaly records (if any)
double	getAnomalyScore()
List<BucketInfluencer>	getBucketInfluencers()
long	getBucketSpan()	Bucketspan expressed in seconds
long	getEventCount()	The number of records (events) actually processed in this bucket.
double	getInitialAnomalyScore()
String	getJobId()
long	getProcessingTimeMs()
List<AnomalyRecord>	getRecords()	Get all the anomaly records associated with this bucket.
List<String>	getScheduledEvents()
Date	getTimestamp()
int	hashCode()
boolean	isInterim()
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

ANOMALY_SCORE

public static final ParseField ANOMALY_SCORE

INITIAL_ANOMALY_SCORE

public static final ParseField INITIAL_ANOMALY_SCORE

EVENT_COUNT

public static final ParseField EVENT_COUNT

RECORDS

public static final ParseField RECORDS

BUCKET_INFLUENCERS

public static final ParseField BUCKET_INFLUENCERS

BUCKET_SPAN

public static final ParseField BUCKET_SPAN

PROCESSING_TIME_MS

public static final ParseField PROCESSING_TIME_MS

SCHEDULED_EVENTS

public static final ParseField SCHEDULED_EVENTS

RESULTS_FIELD

public static final ParseField RESULTS_FIELD

RESULT_TYPE_VALUE

public static final String RESULT_TYPE_VALUE

Result type

See Also:

Constant Field Values

RESULT_TYPE_FIELD

public static final ParseField RESULT_TYPE_FIELD

PARSER

public static final ConstructingObjectParser<Bucket,Void> PARSER

Method Detail

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getJobId

public String getJobId()

getTimestamp

public Date getTimestamp()

getBucketSpan

public long getBucketSpan()

Bucketspan expressed in seconds

getAnomalyScore

public double getAnomalyScore()

getInitialAnomalyScore

public double getInitialAnomalyScore()

getRecords

public List<AnomalyRecord> getRecords()

Get all the anomaly records associated with this bucket. The records are not part of the bucket document. They will only be present when the bucket was retrieved and expanded to contain the associated records.

Returns:

the anomaly records for the bucket IF the bucket was expanded.

getEventCount

public long getEventCount()

The number of records (events) actually processed in this bucket.

isInterim

public boolean isInterim()

getProcessingTimeMs

public long getProcessingTimeMs()

getBucketInfluencers

public List<BucketInfluencer> getBucketInfluencers()

getScheduledEvents

public List<String> getScheduledEvents()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object other)

Compare all the fields and embedded anomaly records (if any)

Overrides:

equals in class Object