co.elastic.clients.elasticsearch.ml.OverallBucket 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.
*/
//----------------------------------------------------
// THIS CODE IS GENERATED. MANUAL EDITS WILL BE LOST.
//----------------------------------------------------
package co.elastic.clients.elasticsearch.ml;
import co.elastic.clients.elasticsearch._types.Time;
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.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.List;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml._types.OverallBucket
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class OverallBucket implements JsonpSerializable {
private final long bucketSpan;
private final boolean isInterim;
private final List jobs;
private final double overallScore;
private final String resultType;
private final Time timestamp;
// ---------------------------------------------------------------------------------------------
private OverallBucket(Builder builder) {
this.bucketSpan = ApiTypeHelper.requireNonNull(builder.bucketSpan, this, "bucketSpan");
this.isInterim = ApiTypeHelper.requireNonNull(builder.isInterim, this, "isInterim");
this.jobs = ApiTypeHelper.unmodifiableRequired(builder.jobs, this, "jobs");
this.overallScore = ApiTypeHelper.requireNonNull(builder.overallScore, this, "overallScore");
this.resultType = ApiTypeHelper.requireNonNull(builder.resultType, this, "resultType");
this.timestamp = ApiTypeHelper.requireNonNull(builder.timestamp, this, "timestamp");
}
public static OverallBucket of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The length of the bucket in seconds. Matches the job with the
* longest bucket_span value.
*
* API name: {@code bucket_span}
*/
public final long bucketSpan() {
return this.bucketSpan;
}
/**
* 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 - An array of objects that contain the max_anomaly_score per job_id.
*
* API name: {@code jobs}
*/
public final List jobs() {
return this.jobs;
}
/**
* Required - The top_n average of the maximum bucket anomaly_score per job.
*
* API name: {@code overall_score}
*/
public final double overallScore() {
return this.overallScore;
}
/**
* Required - Internal. This is always set to overall_bucket.
*
* 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 Time timestamp() {
return this.timestamp;
}
/**
* 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("is_interim");
generator.write(this.isInterim);
if (ApiTypeHelper.isDefined(this.jobs)) {
generator.writeKey("jobs");
generator.writeStartArray();
for (OverallBucketJob item0 : this.jobs) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
generator.writeKey("overall_score");
generator.write(this.overallScore);
generator.writeKey("result_type");
generator.write(this.resultType);
generator.writeKey("timestamp");
this.timestamp.serialize(generator, mapper);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link OverallBucket}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
private Long bucketSpan;
private Boolean isInterim;
private List jobs;
private Double overallScore;
private String resultType;
private Time timestamp;
/**
* Required - The length of the bucket in seconds. Matches the job with the
* longest bucket_span value.
*
* API name: {@code bucket_span}
*/
public final Builder bucketSpan(long value) {
this.bucketSpan = 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 - An array of objects that contain the max_anomaly_score per job_id.
*
* API name: {@code jobs}
*
* Adds all elements of list to jobs.
*/
public final Builder jobs(List list) {
this.jobs = _listAddAll(this.jobs, list);
return this;
}
/**
* Required - An array of objects that contain the max_anomaly_score per job_id.
*
* API name: {@code jobs}
*
* Adds one or more values to jobs.
*/
public final Builder jobs(OverallBucketJob value, OverallBucketJob... values) {
this.jobs = _listAdd(this.jobs, value, values);
return this;
}
/**
* Required - An array of objects that contain the max_anomaly_score per job_id.
*
* API name: {@code jobs}
*
* Adds a value to jobs using a builder lambda.
*/
public final Builder jobs(Function> fn) {
return jobs(fn.apply(new OverallBucketJob.Builder()).build());
}
/**
* Required - The top_n average of the maximum bucket anomaly_score per job.
*
* API name: {@code overall_score}
*/
public final Builder overallScore(double value) {
this.overallScore = value;
return this;
}
/**
* Required - Internal. This is always set to overall_bucket.
*
* 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(Time value) {
this.timestamp = value;
return this;
}
/**
* Required - The start time of the bucket for which these results were
* calculated.
*
* API name: {@code timestamp}
*/
public final Builder timestamp(Function> fn) {
return this.timestamp(fn.apply(new Time.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link OverallBucket}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public OverallBucket build() {
_checkSingleUse();
return new OverallBucket(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link OverallBucket}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
OverallBucket::setupOverallBucketDeserializer);
protected static void setupOverallBucketDeserializer(ObjectDeserializer op) {
op.add(Builder::bucketSpan, JsonpDeserializer.longDeserializer(), "bucket_span");
op.add(Builder::isInterim, JsonpDeserializer.booleanDeserializer(), "is_interim");
op.add(Builder::jobs, JsonpDeserializer.arrayDeserializer(OverallBucketJob._DESERIALIZER), "jobs");
op.add(Builder::overallScore, JsonpDeserializer.doubleDeserializer(), "overall_score");
op.add(Builder::resultType, JsonpDeserializer.stringDeserializer(), "result_type");
op.add(Builder::timestamp, Time._DESERIALIZER, "timestamp");
}
}