co.elastic.clients.elasticsearch.ml.DataframeAnalytics 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.elasticsearch._types.NodeAttributes;
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.String;
import java.util.List;
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.DataframeAnalytics
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DataframeAnalytics implements JsonpSerializable {
@Nullable
private final DataframeAnalyticsStats analysisStats;
@Nullable
private final String assignmentExplanation;
private final DataframeAnalyticsStatsDataCounts dataCounts;
private final String id;
private final DataframeAnalyticsStatsMemoryUsage memoryUsage;
@Nullable
private final NodeAttributes node;
private final List progress;
private final DataframeState state;
// ---------------------------------------------------------------------------------------------
private DataframeAnalytics(Builder builder) {
this.analysisStats = builder.analysisStats;
this.assignmentExplanation = builder.assignmentExplanation;
this.dataCounts = ApiTypeHelper.requireNonNull(builder.dataCounts, this, "dataCounts");
this.id = ApiTypeHelper.requireNonNull(builder.id, this, "id");
this.memoryUsage = ApiTypeHelper.requireNonNull(builder.memoryUsage, this, "memoryUsage");
this.node = builder.node;
this.progress = ApiTypeHelper.unmodifiableRequired(builder.progress, this, "progress");
this.state = ApiTypeHelper.requireNonNull(builder.state, this, "state");
}
public static DataframeAnalytics of(Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* An object containing information about the analysis job.
*
* API name: {@code analysis_stats}
*/
@Nullable
public final DataframeAnalyticsStats analysisStats() {
return this.analysisStats;
}
/**
* For running 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 provides counts for the quantity of documents
* skipped, used in training, or available for testing.
*
* API name: {@code data_counts}
*/
public final DataframeAnalyticsStatsDataCounts dataCounts() {
return this.dataCounts;
}
/**
* Required - The unique identifier of the data frame analytics job.
*
* API name: {@code id}
*/
public final String id() {
return this.id;
}
/**
* Required - An object describing memory usage of the analytics. It is present
* only after the job is started and memory usage is reported.
*
* API name: {@code memory_usage}
*/
public final DataframeAnalyticsStatsMemoryUsage memoryUsage() {
return this.memoryUsage;
}
/**
* Contains properties for the node that runs the job. This information is
* available only for running jobs.
*
* API name: {@code node}
*/
@Nullable
public final NodeAttributes node() {
return this.node;
}
/**
* Required - The progress report of the data frame analytics job by phase.
*
* API name: {@code progress}
*/
public final List progress() {
return this.progress;
}
/**
* Required - The status of the data frame analytics job, which can be one of
* the following values: failed, started, starting, stopping, stopped.
*
* API name: {@code state}
*/
public final DataframeState state() {
return this.state;
}
/**
* 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.analysisStats != null) {
generator.writeKey("analysis_stats");
this.analysisStats.serialize(generator, mapper);
}
if (this.assignmentExplanation != null) {
generator.writeKey("assignment_explanation");
generator.write(this.assignmentExplanation);
}
generator.writeKey("data_counts");
this.dataCounts.serialize(generator, mapper);
generator.writeKey("id");
generator.write(this.id);
generator.writeKey("memory_usage");
this.memoryUsage.serialize(generator, mapper);
if (this.node != null) {
generator.writeKey("node");
this.node.serialize(generator, mapper);
}
if (ApiTypeHelper.isDefined(this.progress)) {
generator.writeKey("progress");
generator.writeStartArray();
for (DataframeAnalyticsStatsProgress item0 : this.progress) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
generator.writeKey("state");
this.state.serialize(generator, mapper);
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DataframeAnalytics}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private DataframeAnalyticsStats analysisStats;
@Nullable
private String assignmentExplanation;
private DataframeAnalyticsStatsDataCounts dataCounts;
private String id;
private DataframeAnalyticsStatsMemoryUsage memoryUsage;
@Nullable
private NodeAttributes node;
private List progress;
private DataframeState state;
/**
* An object containing information about the analysis job.
*
* API name: {@code analysis_stats}
*/
public final Builder analysisStats(@Nullable DataframeAnalyticsStats value) {
this.analysisStats = value;
return this;
}
/**
* An object containing information about the analysis job.
*
* API name: {@code analysis_stats}
*/
public final Builder analysisStats(
Function> fn) {
return this.analysisStats(fn.apply(new DataframeAnalyticsStats.Builder()).build());
}
/**
* For running 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 provides counts for the quantity of documents
* skipped, used in training, or available for testing.
*
* API name: {@code data_counts}
*/
public final Builder dataCounts(DataframeAnalyticsStatsDataCounts value) {
this.dataCounts = value;
return this;
}
/**
* Required - An object that provides counts for the quantity of documents
* skipped, used in training, or available for testing.
*
* API name: {@code data_counts}
*/
public final Builder dataCounts(
Function> fn) {
return this.dataCounts(fn.apply(new DataframeAnalyticsStatsDataCounts.Builder()).build());
}
/**
* Required - The unique identifier of the data frame analytics job.
*
* API name: {@code id}
*/
public final Builder id(String value) {
this.id = value;
return this;
}
/**
* Required - An object describing memory usage of the analytics. It is present
* only after the job is started and memory usage is reported.
*
* API name: {@code memory_usage}
*/
public final Builder memoryUsage(DataframeAnalyticsStatsMemoryUsage value) {
this.memoryUsage = value;
return this;
}
/**
* Required - An object describing memory usage of the analytics. It is present
* only after the job is started and memory usage is reported.
*
* API name: {@code memory_usage}
*/
public final Builder memoryUsage(
Function> fn) {
return this.memoryUsage(fn.apply(new DataframeAnalyticsStatsMemoryUsage.Builder()).build());
}
/**
* Contains properties for the node that runs the job. This information is
* available only for running jobs.
*
* API name: {@code node}
*/
public final Builder node(@Nullable NodeAttributes value) {
this.node = value;
return this;
}
/**
* Contains properties for the node that runs the job. This information is
* available only for running jobs.
*
* API name: {@code node}
*/
public final Builder node(Function> fn) {
return this.node(fn.apply(new NodeAttributes.Builder()).build());
}
/**
* Required - The progress report of the data frame analytics job by phase.
*
* API name: {@code progress}
*
* Adds all elements of list to progress.
*/
public final Builder progress(List list) {
this.progress = _listAddAll(this.progress, list);
return this;
}
/**
* Required - The progress report of the data frame analytics job by phase.
*
* API name: {@code progress}
*
* Adds one or more values to progress.
*/
public final Builder progress(DataframeAnalyticsStatsProgress value,
DataframeAnalyticsStatsProgress... values) {
this.progress = _listAdd(this.progress, value, values);
return this;
}
/**
* Required - The progress report of the data frame analytics job by phase.
*
* API name: {@code progress}
*
* Adds a value to progress using a builder lambda.
*/
public final Builder progress(
Function> fn) {
return progress(fn.apply(new DataframeAnalyticsStatsProgress.Builder()).build());
}
/**
* Required - The status of the data frame analytics job, which can be one of
* the following values: failed, started, starting, stopping, stopped.
*
* API name: {@code state}
*/
public final Builder state(DataframeState value) {
this.state = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DataframeAnalytics}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DataframeAnalytics build() {
_checkSingleUse();
return new DataframeAnalytics(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DataframeAnalytics}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, DataframeAnalytics::setupDataframeAnalyticsDeserializer);
protected static void setupDataframeAnalyticsDeserializer(ObjectDeserializer op) {
op.add(Builder::analysisStats, DataframeAnalyticsStats._DESERIALIZER, "analysis_stats");
op.add(Builder::assignmentExplanation, JsonpDeserializer.stringDeserializer(), "assignment_explanation");
op.add(Builder::dataCounts, DataframeAnalyticsStatsDataCounts._DESERIALIZER, "data_counts");
op.add(Builder::id, JsonpDeserializer.stringDeserializer(), "id");
op.add(Builder::memoryUsage, DataframeAnalyticsStatsMemoryUsage._DESERIALIZER, "memory_usage");
op.add(Builder::node, NodeAttributes._DESERIALIZER, "node");
op.add(Builder::progress, JsonpDeserializer.arrayDeserializer(DataframeAnalyticsStatsProgress._DESERIALIZER),
"progress");
op.add(Builder::state, DataframeState._DESERIALIZER, "state");
}
}