co.elastic.clients.elasticsearch.ml.JobStats 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.DateTime;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
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.JobStats
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class JobStats implements JsonpSerializable {
@Nullable
private final String assignmentExplanation;
private final DataCounts dataCounts;
private final JobForecastStatistics forecastsStats;
private final String jobId;
private final ModelSizeStats modelSizeStats;
@Nullable
private final DiscoveryNode node;
@Nullable
private final DateTime openTime;
private final JobState state;
private final JobTimingStats timingStats;
@Nullable
private final Boolean deleting;
// ---------------------------------------------------------------------------------------------
private JobStats(Builder builder) {
this.assignmentExplanation = builder.assignmentExplanation;
this.dataCounts = ApiTypeHelper.requireNonNull(builder.dataCounts, this, "dataCounts");
this.forecastsStats = ApiTypeHelper.requireNonNull(builder.forecastsStats, this, "forecastsStats");
this.jobId = ApiTypeHelper.requireNonNull(builder.jobId, this, "jobId");
this.modelSizeStats = ApiTypeHelper.requireNonNull(builder.modelSizeStats, this, "modelSizeStats");
this.node = builder.node;
this.openTime = builder.openTime;
this.state = ApiTypeHelper.requireNonNull(builder.state, this, "state");
this.timingStats = ApiTypeHelper.requireNonNull(builder.timingStats, this, "timingStats");
this.deleting = builder.deleting;
}
public static JobStats of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* For open anomaly detection jobs only, contains messages relating to the
* selection of a node to run the job.
*
* API name: {@code assignment_explanation}
*/
@Nullable
public final String assignmentExplanation() {
return this.assignmentExplanation;
}
/**
* Required - An object that describes the quantity of input to the job and any
* related error counts. The data_count values are cumulative for
* the lifetime of a job. If a model snapshot is reverted or old results are
* deleted, the job counts are not reset.
*
* API name: {@code data_counts}
*/
public final DataCounts dataCounts() {
return this.dataCounts;
}
/**
* Required - An object that provides statistical information about forecasts
* belonging to this job. Some statistics are omitted if no forecasts have been
* made.
*
* API name: {@code forecasts_stats}
*/
public final JobForecastStatistics forecastsStats() {
return this.forecastsStats;
}
/**
* Required - Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final String jobId() {
return this.jobId;
}
/**
* Required - An object that provides information about the size and contents of
* the model.
*
* API name: {@code model_size_stats}
*/
public final ModelSizeStats modelSizeStats() {
return this.modelSizeStats;
}
/**
* Contains properties for the node that runs the job. This information is
* available only for open jobs.
*
* API name: {@code node}
*/
@Nullable
public final DiscoveryNode node() {
return this.node;
}
/**
* For open jobs only, the elapsed time for which the job has been open.
*
* API name: {@code open_time}
*/
@Nullable
public final DateTime openTime() {
return this.openTime;
}
/**
* Required - The status of the anomaly detection job, which can be one of the
* following values: closed, closing,
* failed, opened, opening.
*
* API name: {@code state}
*/
public final JobState state() {
return this.state;
}
/**
* Required - An object that provides statistical information about timing
* aspect of this job.
*
* API name: {@code timing_stats}
*/
public final JobTimingStats timingStats() {
return this.timingStats;
}
/**
* Indicates that the process of deleting the job is in progress but not yet
* completed. It is only reported when true.
*
* API name: {@code deleting}
*/
@Nullable
public final Boolean deleting() {
return this.deleting;
}
/**
* 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) {
if (this.assignmentExplanation != null) {
generator.writeKey("assignment_explanation");
generator.write(this.assignmentExplanation);
}
generator.writeKey("data_counts");
this.dataCounts.serialize(generator, mapper);
generator.writeKey("forecasts_stats");
this.forecastsStats.serialize(generator, mapper);
generator.writeKey("job_id");
generator.write(this.jobId);
generator.writeKey("model_size_stats");
this.modelSizeStats.serialize(generator, mapper);
if (this.node != null) {
generator.writeKey("node");
this.node.serialize(generator, mapper);
}
if (this.openTime != null) {
generator.writeKey("open_time");
this.openTime.serialize(generator, mapper);
}
generator.writeKey("state");
this.state.serialize(generator, mapper);
generator.writeKey("timing_stats");
this.timingStats.serialize(generator, mapper);
if (this.deleting != null) {
generator.writeKey("deleting");
generator.write(this.deleting);
}
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link JobStats}.
*/
public static class Builder extends WithJsonObjectBuilderBase implements ObjectBuilder {
@Nullable
private String assignmentExplanation;
private DataCounts dataCounts;
private JobForecastStatistics forecastsStats;
private String jobId;
private ModelSizeStats modelSizeStats;
@Nullable
private DiscoveryNode node;
@Nullable
private DateTime openTime;
private JobState state;
private JobTimingStats timingStats;
@Nullable
private Boolean deleting;
/**
* For open anomaly detection jobs only, contains messages relating to the
* selection of a node to run the job.
*
* API name: {@code assignment_explanation}
*/
public final Builder assignmentExplanation(@Nullable String value) {
this.assignmentExplanation = value;
return this;
}
/**
* Required - An object that describes the quantity of input to the job and any
* related error counts. The data_count values are cumulative for
* the lifetime of a job. If a model snapshot is reverted or old results are
* deleted, the job counts are not reset.
*
* API name: {@code data_counts}
*/
public final Builder dataCounts(DataCounts value) {
this.dataCounts = value;
return this;
}
/**
* Required - An object that describes the quantity of input to the job and any
* related error counts. The data_count values are cumulative for
* the lifetime of a job. If a model snapshot is reverted or old results are
* deleted, the job counts are not reset.
*
* API name: {@code data_counts}
*/
public final Builder dataCounts(Function> fn) {
return this.dataCounts(fn.apply(new DataCounts.Builder()).build());
}
/**
* Required - An object that provides statistical information about forecasts
* belonging to this job. Some statistics are omitted if no forecasts have been
* made.
*
* API name: {@code forecasts_stats}
*/
public final Builder forecastsStats(JobForecastStatistics value) {
this.forecastsStats = value;
return this;
}
/**
* Required - An object that provides statistical information about forecasts
* belonging to this job. Some statistics are omitted if no forecasts have been
* made.
*
* API name: {@code forecasts_stats}
*/
public final Builder forecastsStats(
Function> fn) {
return this.forecastsStats(fn.apply(new JobForecastStatistics.Builder()).build());
}
/**
* Required - Identifier for the anomaly detection job.
*
* API name: {@code job_id}
*/
public final Builder jobId(String value) {
this.jobId = value;
return this;
}
/**
* Required - An object that provides information about the size and contents of
* the model.
*
* API name: {@code model_size_stats}
*/
public final Builder modelSizeStats(ModelSizeStats value) {
this.modelSizeStats = value;
return this;
}
/**
* Required - An object that provides information about the size and contents of
* the model.
*
* API name: {@code model_size_stats}
*/
public final Builder modelSizeStats(Function> fn) {
return this.modelSizeStats(fn.apply(new ModelSizeStats.Builder()).build());
}
/**
* Contains properties for the node that runs the job. This information is
* available only for open jobs.
*
* API name: {@code node}
*/
public final Builder node(@Nullable DiscoveryNode value) {
this.node = value;
return this;
}
/**
* Contains properties for the node that runs the job. This information is
* available only for open jobs.
*
* API name: {@code node}
*/
public final Builder node(Function> fn) {
return this.node(fn.apply(new DiscoveryNode.Builder()).build());
}
/**
* For open jobs only, the elapsed time for which the job has been open.
*
* API name: {@code open_time}
*/
public final Builder openTime(@Nullable DateTime value) {
this.openTime = value;
return this;
}
/**
* Required - The status of the anomaly detection job, which can be one of the
* following values: closed, closing,
* failed, opened, opening.
*
* API name: {@code state}
*/
public final Builder state(JobState value) {
this.state = value;
return this;
}
/**
* Required - An object that provides statistical information about timing
* aspect of this job.
*
* API name: {@code timing_stats}
*/
public final Builder timingStats(JobTimingStats value) {
this.timingStats = value;
return this;
}
/**
* Required - An object that provides statistical information about timing
* aspect of this job.
*
* API name: {@code timing_stats}
*/
public final Builder timingStats(Function> fn) {
return this.timingStats(fn.apply(new JobTimingStats.Builder()).build());
}
/**
* Indicates that the process of deleting the job is in progress but not yet
* completed. It is only reported when true.
*
* API name: {@code deleting}
*/
public final Builder deleting(@Nullable Boolean value) {
this.deleting = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link JobStats}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public JobStats build() {
_checkSingleUse();
return new JobStats(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link JobStats}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer.lazy(Builder::new,
JobStats::setupJobStatsDeserializer);
protected static void setupJobStatsDeserializer(ObjectDeserializer op) {
op.add(Builder::assignmentExplanation, JsonpDeserializer.stringDeserializer(), "assignment_explanation");
op.add(Builder::dataCounts, DataCounts._DESERIALIZER, "data_counts");
op.add(Builder::forecastsStats, JobForecastStatistics._DESERIALIZER, "forecasts_stats");
op.add(Builder::jobId, JsonpDeserializer.stringDeserializer(), "job_id");
op.add(Builder::modelSizeStats, ModelSizeStats._DESERIALIZER, "model_size_stats");
op.add(Builder::node, DiscoveryNode._DESERIALIZER, "node");
op.add(Builder::openTime, DateTime._DESERIALIZER, "open_time");
op.add(Builder::state, JobState._DESERIALIZER, "state");
op.add(Builder::timingStats, JobTimingStats._DESERIALIZER, "timing_stats");
op.add(Builder::deleting, JsonpDeserializer.booleanDeserializer(), "deleting");
}
}