co.elastic.clients.elasticsearch.ml.Influencer Maven / Gradle / Ivy
Show all versions of elasticsearch-java Show documentation
/*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.json.JsonpDeserializable;
import co.elastic.clients.json.JsonpDeserializer;
import co.elastic.clients.json.JsonpMapper;
import co.elastic.clients.json.JsonpSerializable;
import co.elastic.clients.json.JsonpUtils;
import co.elastic.clients.json.ObjectBuilderDeserializer;
import co.elastic.clients.json.ObjectDeserializer;
import co.elastic.clients.util.ApiTypeHelper;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Double;
import java.lang.Long;
import java.lang.String;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
//----------------------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------------------
//
// This code is generated from the Elasticsearch API specification
// at https://github.com/elastic/elasticsearch-specification
//
// Manual updates to this file will be lost when the code is
// re-generated.
//
// If you find a property that is missing or wrongly typed, please
// open an issue or a PR on the API specification repository.
//
//----------------------------------------------------------------
// typedef: ml._types.Influencer
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class Influencer implements JsonpSerializable {
private final long bucketSpan;
private final double influencerScore;
private final String influencerFieldName;
private final String influencerFieldValue;
private final double initialInfluencerScore;
private final boolean isInterim;
private final String jobId;
private final double probability;
private final String resultType;
private final long timestamp;
@Nullable
private final String foo;
// ---------------------------------------------------------------------------------------------
private Influencer(Builder builder) {
this.bucketSpan = ApiTypeHelper.requireNonNull(builder.bucketSpan, this, "bucketSpan");
this.influencerScore = ApiTypeHelper.requireNonNull(builder.influencerScore, this, "influencerScore");
this.influencerFieldName = ApiTypeHelper.requireNonNull(builder.influencerFieldName, this,
"influencerFieldName");
this.influencerFieldValue = ApiTypeHelper.requireNonNull(builder.influencerFieldValue, this,
"influencerFieldValue");
this.initialInfluencerScore = ApiTypeHelper.requireNonNull(builder.initialInfluencerScore, this,
"initialInfluencerScore");
this.isInterim = ApiTypeHelper.requireNonNull(builder.isInterim, this, "isInterim");
this.jobId = ApiTypeHelper.requireNonNull(builder.jobId, this, "jobId");
this.probability = ApiTypeHelper.requireNonNull(builder.probability, this, "probability");
this.resultType = ApiTypeHelper.requireNonNull(builder.resultType, this, "resultType");
this.timestamp = ApiTypeHelper.requireNonNull(builder.timestamp, this, "timestamp");
this.foo = builder.foo;
}
public static Influencer of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The length of the bucket in seconds. This value matches the bucket
* span that is specified in the job.
*
* API name: {@code bucket_span}
*/
public final long bucketSpan() {
return this.bucketSpan;
}
/**
* Required - A normalized score between 0-100, which is based on the
* probability of the influencer in this bucket aggregated across detectors.
* Unlike initial_influencer_score, this value is updated by a
* re-normalization process as new data is analyzed.
*
* API name: {@code influencer_score}
*/
public final double influencerScore() {
return this.influencerScore;
}
/**
* Required - The field name of the influencer.
*
* API name: {@code influencer_field_name}
*/
public final String influencerFieldName() {
return this.influencerFieldName;
}
/**
* Required - The entity that influenced, contributed to, or was to blame for
* the anomaly.
*
* API name: {@code influencer_field_value}
*/
public final String influencerFieldValue() {
return this.influencerFieldValue;
}
/**
* 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: {@code initial_influencer_score}
*/
public final double initialInfluencerScore() {
return this.initialInfluencerScore;
}
/**
* Required - If true, this is an interim result. In other words, the results
* are calculated based on partial input data.
*
* API name: {@code is_interim}
*/
public final boolean isInterim() {
return this.isInterim;
}
/**
* Required - Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final String jobId() {
return this.jobId;
}
/**
* 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 the influencer_score is provided as a human-readable
* and friendly interpretation of this value.
*
* API name: {@code probability}
*/
public final double probability() {
return this.probability;
}
/**
* Required - Internal. This value is always set to influencer.
*
* API name: {@code result_type}
*/
public final String resultType() {
return this.resultType;
}
/**
* Required - The start time of the bucket for which these results were
* calculated.
*
* API name: {@code timestamp}
*/
public final long timestamp() {
return this.timestamp;
}
/**
* Additional influencer properties are added, depending on the fields being
* analyzed. For example, if it’s analyzing user_name as an
* influencer, a field user_name is added to the result document.
* This information enables you to filter the anomaly results more easily.
*
* API name: {@code foo}
*/
@Nullable
public final String foo() {
return this.foo;
}
/**
* Serialize this object to JSON.
*/
public void serialize(JsonGenerator generator, JsonpMapper mapper) {
generator.writeStartObject();
serializeInternal(generator, mapper);
generator.writeEnd();
}
protected void serializeInternal(JsonGenerator generator, JsonpMapper mapper) {
generator.writeKey("bucket_span");
generator.write(this.bucketSpan);
generator.writeKey("influencer_score");
generator.write(this.influencerScore);
generator.writeKey("influencer_field_name");
generator.write(this.influencerFieldName);
generator.writeKey("influencer_field_value");
generator.write(this.influencerFieldValue);
generator.writeKey("initial_influencer_score");
generator.write(this.initialInfluencerScore);
generator.writeKey("is_interim");
generator.write(this.isInterim);
generator.writeKey("job_id");
generator.write(this.jobId);
generator.writeKey("probability");
generator.write(this.probability);
generator.writeKey("result_type");
generator.write(this.resultType);
generator.writeKey("timestamp");
generator.write(this.timestamp);
if (this.foo != null) {
generator.writeKey("foo");
generator.write(this.foo);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link Influencer}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
private Long bucketSpan;
private Double influencerScore;
private String influencerFieldName;
private String influencerFieldValue;
private Double initialInfluencerScore;
private Boolean isInterim;
private String jobId;
private Double probability;
private String resultType;
private Long timestamp;
@Nullable
private String foo;
/**
* Required - The length of the bucket in seconds. This value matches the bucket
* span that is specified in the job.
*
* API name: {@code bucket_span}
*/
public final Builder bucketSpan(long value) {
this.bucketSpan = value;
return this;
}
/**
* Required - A normalized score between 0-100, which is based on the
* probability of the influencer in this bucket aggregated across detectors.
* Unlike initial_influencer_score, this value is updated by a
* re-normalization process as new data is analyzed.
*
* API name: {@code influencer_score}
*/
public final Builder influencerScore(double value) {
this.influencerScore = value;
return this;
}
/**
* Required - The field name of the influencer.
*
* API name: {@code influencer_field_name}
*/
public final Builder influencerFieldName(String value) {
this.influencerFieldName = value;
return this;
}
/**
* Required - The entity that influenced, contributed to, or was to blame for
* the anomaly.
*
* API name: {@code influencer_field_value}
*/
public final Builder influencerFieldValue(String value) {
this.influencerFieldValue = value;
return this;
}
/**
* 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: {@code initial_influencer_score}
*/
public final Builder initialInfluencerScore(double value) {
this.initialInfluencerScore = value;
return this;
}
/**
* Required - If true, this is an interim result. In other words, the results
* are calculated based on partial input data.
*
* API name: {@code is_interim}
*/
public final Builder isInterim(boolean value) {
this.isInterim = value;
return this;
}
/**
* Required - Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final Builder jobId(String value) {
this.jobId = value;
return this;
}
/**
* 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 the influencer_score is provided as a human-readable
* and friendly interpretation of this value.
*
* API name: {@code probability}
*/
public final Builder probability(double value) {
this.probability = value;
return this;
}
/**
* Required - Internal. This value is always set to influencer.
*
* API name: {@code result_type}
*/
public final Builder resultType(String value) {
this.resultType = value;
return this;
}
/**
* Required - The start time of the bucket for which these results were
* calculated.
*
* API name: {@code timestamp}
*/
public final Builder timestamp(long value) {
this.timestamp = value;
return this;
}
/**
* Additional influencer properties are added, depending on the fields being
* analyzed. For example, if it’s analyzing user_name as an
* influencer, a field user_name is added to the result document.
* This information enables you to filter the anomaly results more easily.
*
* API name: {@code foo}
*/
public final Builder foo(@Nullable String value) {
this.foo = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link Influencer}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public Influencer build() {
_checkSingleUse();
return new Influencer(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link Influencer}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
Influencer::setupInfluencerDeserializer);
protected static void setupInfluencerDeserializer(ObjectDeserializer op) {
op.add(Builder::bucketSpan, JsonpDeserializer.longDeserializer(), "bucket_span");
op.add(Builder::influencerScore, JsonpDeserializer.doubleDeserializer(), "influencer_score");
op.add(Builder::influencerFieldName, JsonpDeserializer.stringDeserializer(), "influencer_field_name");
op.add(Builder::influencerFieldValue, JsonpDeserializer.stringDeserializer(), "influencer_field_value");
op.add(Builder::initialInfluencerScore, JsonpDeserializer.doubleDeserializer(), "initial_influencer_score");
op.add(Builder::isInterim, JsonpDeserializer.booleanDeserializer(), "is_interim");
op.add(Builder::jobId, JsonpDeserializer.stringDeserializer(), "job_id");
op.add(Builder::probability, JsonpDeserializer.doubleDeserializer(), "probability");
op.add(Builder::resultType, JsonpDeserializer.stringDeserializer(), "result_type");
op.add(Builder::timestamp, JsonpDeserializer.longDeserializer(), "timestamp");
op.add(Builder::foo, JsonpDeserializer.stringDeserializer(), "foo");
}
}