Class Influencer
java.lang.Object
co.elastic.clients.elasticsearch.ml.Influencer
- All Implemented Interfaces:
JsonpSerializable
@JsonpDeserializable public class Influencer extends java.lang.Object implements JsonpSerializable
- See Also:
- API specification
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Influencer.Builder
Builder forInfluencer
. -
Field Summary
Fields Modifier and Type Field Description static JsonpDeserializer<Influencer>
_DESERIALIZER
Json deserializer forInfluencer
-
Method Summary
Modifier and Type Method Description long
bucketSpan()
Required - The length of the bucket in seconds.java.lang.String
foo()
Additional influencer properties are added, depending on the fields being analyzed.java.lang.String
influencerFieldName()
Required - The field name of the influencer.java.lang.String
influencerFieldValue()
Required - The entity that influenced, contributed to, or was to blame for the anomaly.double
influencerScore()
Required - A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated across detectors.double
initialInfluencerScore()
Required - A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors.boolean
isInterim()
Required - If true, this is an interim result.java.lang.String
jobId()
Required - Identifier for the anomaly detection job.static Influencer
of(java.util.function.Function<Influencer.Builder,ObjectBuilder<Influencer>> fn)
double
probability()
Required - The probability that the influencer has this behavior, in the range 0 to 1.java.lang.String
resultType()
Required - Internal.void
serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
Serialize this object to JSON.protected void
serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void
setupInfluencerDeserializer(ObjectDeserializer<Influencer.Builder> op)
Time
timestamp()
Required - The start time of the bucket for which these results were calculated.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Field Details
-
_DESERIALIZER
Json deserializer forInfluencer
-
-
Method Details
-
of
public static Influencer of(java.util.function.Function<Influencer.Builder,ObjectBuilder<Influencer>> fn) -
bucketSpan
public final long bucketSpan()Required - The length of the bucket in seconds. This value matches the bucket span that is specified in the job.API name:
bucket_span
-
influencerScore
public final double influencerScore()Required - A normalized score between 0-100, which is based on the probability of the influencer in this bucket aggregated across detectors. Unlikeinitial_influencer_score
, this value is updated by a re-normalization process as new data is analyzed.API name:
influencer_score
-
influencerFieldName
public final java.lang.String influencerFieldName()Required - The field name of the influencer.API name:
influencer_field_name
-
influencerFieldValue
public final java.lang.String influencerFieldValue()Required - The entity that influenced, contributed to, or was to blame for the anomaly.API name:
influencer_field_value
-
initialInfluencerScore
public final double initialInfluencerScore()Required - A normalized score between 0-100, which is based on the probability of the influencer aggregated across detectors. This is the initial value that was calculated at the time the bucket was processed.API name:
initial_influencer_score
-
isInterim
public final boolean isInterim()Required - If true, this is an interim result. In other words, the results are calculated based on partial input data.API name:
is_interim
-
jobId
public final java.lang.String jobId()Required - Identifier for the anomaly detection job.API name:
job_id
-
probability
public final double probability()Required - The probability that the influencer has this behavior, in the range 0 to 1. This value can be held to a high precision of over 300 decimal places, so theinfluencer_score
is provided as a human-readable and friendly interpretation of this value.API name:
probability
-
resultType
public final java.lang.String resultType()Required - Internal. This value is always set toinfluencer
.API name:
result_type
-
timestamp
Required - The start time of the bucket for which these results were calculated.API name:
timestamp
-
foo
@Nullable public final java.lang.String foo()Additional influencer properties are added, depending on the fields being analyzed. For example, if it’s analyzinguser_name
as an influencer, a fielduser_name
is added to the result document. This information enables you to filter the anomaly results more easily.API name:
foo
-
serialize
Serialize this object to JSON.- Specified by:
serialize
in interfaceJsonpSerializable
-
serializeInternal
-
setupInfluencerDeserializer
-