java.lang.Object
org.elasticsearch.xpack.core.ml.job.results.Bucket
- All Implemented Interfaces:
Writeable,org.elasticsearch.xcontent.ToXContent,org.elasticsearch.xcontent.ToXContentObject
public class Bucket
extends Object
implements org.elasticsearch.xcontent.ToXContentObject, Writeable
Bucket Result POJO
-
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.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldstatic final StringResult typestatic final org.elasticsearch.xcontent.ParseFieldstatic final org.elasticsearch.xcontent.ParseFieldFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidaddBucketInfluencer(BucketInfluencer bucketInfluencer) booleanCompare all the fields and embedded anomaly records (if any)doublelongBucketspan expressed in secondslonggetEpoch()Timestamp expressed in seconds since the epoch (rather than Java's convention of milliseconds).longThe number of records (events) actually processed in this bucket.getId()doublegetJobId()longGet all the anomaly records associated with this bucket.inthashCode()booleanbooleanThis method encapsulated the logic for whether a bucket should be normalized.static BucketvoidsetAnomalyScore(double anomalyScore) voidsetBucketInfluencers(List<BucketInfluencer> bucketInfluencers) voidsetEventCount(long value) voidsetInitialAnomalyScore(double initialAnomalyScore) voidsetInterim(boolean interim) voidsetProcessingTimeMs(long timeMs) voidsetRecords(List<AnomalyRecord> records) voidsetScheduledEvents(List<String> scheduledEvents) toString()org.elasticsearch.xcontent.XContentBuildertoXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) voidwriteTo(StreamOutput out) Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragment
-
Field Details
-
ANOMALY_SCORE
public static final org.elasticsearch.xcontent.ParseField ANOMALY_SCORE -
INITIAL_ANOMALY_SCORE
public static final org.elasticsearch.xcontent.ParseField INITIAL_ANOMALY_SCORE -
EVENT_COUNT
public static final org.elasticsearch.xcontent.ParseField EVENT_COUNT -
RECORDS
public static final org.elasticsearch.xcontent.ParseField RECORDS -
BUCKET_INFLUENCERS
public static final org.elasticsearch.xcontent.ParseField BUCKET_INFLUENCERS -
BUCKET_SPAN
public static final org.elasticsearch.xcontent.ParseField BUCKET_SPAN -
PROCESSING_TIME_MS
public static final org.elasticsearch.xcontent.ParseField PROCESSING_TIME_MS -
SCHEDULED_EVENTS
public static final org.elasticsearch.xcontent.ParseField SCHEDULED_EVENTS -
RESULTS_FIELD
public static final org.elasticsearch.xcontent.ParseField RESULTS_FIELD -
RESULT_TYPE_VALUE
Result type- See Also:
-
RESULT_TYPE_FIELD
public static final org.elasticsearch.xcontent.ParseField RESULT_TYPE_FIELD -
STRICT_PARSER
-
LENIENT_PARSER
-
-
Constructor Details
-
Bucket
-
Bucket
-
Bucket
- Throws:
IOException
-
-
Method Details
-
readOldPerPartitionNormalization
- Throws:
IOException
-
writeTo
- Specified by:
writeToin interfaceWriteable- Throws:
IOException
-
toXContent
public org.elasticsearch.xcontent.XContentBuilder toXContent(org.elasticsearch.xcontent.XContentBuilder builder, org.elasticsearch.xcontent.ToXContent.Params params) throws IOException - Specified by:
toXContentin interfaceorg.elasticsearch.xcontent.ToXContent- Throws:
IOException
-
getJobId
-
getId
-
getEpoch
public long getEpoch()Timestamp expressed in seconds since the epoch (rather than Java's convention of milliseconds). -
getTimestamp
-
getBucketSpan
public long getBucketSpan()Bucketspan expressed in seconds -
getAnomalyScore
public double getAnomalyScore() -
setAnomalyScore
public void setAnomalyScore(double anomalyScore) -
getInitialAnomalyScore
public double getInitialAnomalyScore() -
setInitialAnomalyScore
public void setInitialAnomalyScore(double initialAnomalyScore) -
toString
-
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.
-
setRecords
-
getEventCount
public long getEventCount()The number of records (events) actually processed in this bucket. -
setEventCount
public void setEventCount(long value) -
isInterim
public boolean isInterim() -
setInterim
public void setInterim(boolean interim) -
getProcessingTimeMs
public long getProcessingTimeMs() -
setProcessingTimeMs
public void setProcessingTimeMs(long timeMs) -
getBucketInfluencers
-
setBucketInfluencers
-
addBucketInfluencer
-
getScheduledEvents
-
setScheduledEvents
-
hashCode
public int hashCode() -
equals
Compare all the fields and embedded anomaly records (if any) -
isNormalizable
public boolean isNormalizable()This method encapsulated the logic for whether a bucket should be normalized. Buckets that have a zero anomaly score themselves and no partition scores with non-zero score should not be normalized as their score will not change and they will just add overhead.- Returns:
- true if the bucket should be normalized or false otherwise
-