co.elastic.clients.elasticsearch.ml.DataframeAnalyticsStatsDataCounts Maven / Gradle / Ivy
Show all versions of org.apache.servicemix.bundles.elasticsearch-java
/*
* 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.Integer;
import java.util.Objects;
import java.util.function.Function;
//----------------------------------------------------------------
// 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.DataframeAnalyticsStatsDataCounts
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class DataframeAnalyticsStatsDataCounts implements JsonpSerializable {
private final int skippedDocsCount;
private final int testDocsCount;
private final int trainingDocsCount;
// ---------------------------------------------------------------------------------------------
private DataframeAnalyticsStatsDataCounts(Builder builder) {
this.skippedDocsCount = ApiTypeHelper.requireNonNull(builder.skippedDocsCount, this, "skippedDocsCount", 0);
this.testDocsCount = ApiTypeHelper.requireNonNull(builder.testDocsCount, this, "testDocsCount", 0);
this.trainingDocsCount = ApiTypeHelper.requireNonNull(builder.trainingDocsCount, this, "trainingDocsCount", 0);
}
public static DataframeAnalyticsStatsDataCounts of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - The number of documents that are skipped during the analysis
* because they contained values that are not supported by the analysis. For
* example, outlier detection does not support missing fields so it skips
* documents with missing fields. Likewise, all types of analysis skip documents
* that contain arrays with more than one element.
*
* API name: {@code skipped_docs_count}
*/
public final int skippedDocsCount() {
return this.skippedDocsCount;
}
/**
* Required - The number of documents that are not used for training the model
* and can be used for testing.
*
* API name: {@code test_docs_count}
*/
public final int testDocsCount() {
return this.testDocsCount;
}
/**
* Required - The number of documents that are used for training the model.
*
* API name: {@code training_docs_count}
*/
public final int trainingDocsCount() {
return this.trainingDocsCount;
}
/**
* 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("skipped_docs_count");
generator.write(this.skippedDocsCount);
generator.writeKey("test_docs_count");
generator.write(this.testDocsCount);
generator.writeKey("training_docs_count");
generator.write(this.trainingDocsCount);
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link DataframeAnalyticsStatsDataCounts}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private Integer skippedDocsCount;
private Integer testDocsCount;
private Integer trainingDocsCount;
/**
* Required - The number of documents that are skipped during the analysis
* because they contained values that are not supported by the analysis. For
* example, outlier detection does not support missing fields so it skips
* documents with missing fields. Likewise, all types of analysis skip documents
* that contain arrays with more than one element.
*
* API name: {@code skipped_docs_count}
*/
public final Builder skippedDocsCount(int value) {
this.skippedDocsCount = value;
return this;
}
/**
* Required - The number of documents that are not used for training the model
* and can be used for testing.
*
* API name: {@code test_docs_count}
*/
public final Builder testDocsCount(int value) {
this.testDocsCount = value;
return this;
}
/**
* Required - The number of documents that are used for training the model.
*
* API name: {@code training_docs_count}
*/
public final Builder trainingDocsCount(int value) {
this.trainingDocsCount = value;
return this;
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link DataframeAnalyticsStatsDataCounts}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public DataframeAnalyticsStatsDataCounts build() {
_checkSingleUse();
return new DataframeAnalyticsStatsDataCounts(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link DataframeAnalyticsStatsDataCounts}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, DataframeAnalyticsStatsDataCounts::setupDataframeAnalyticsStatsDataCountsDeserializer);
protected static void setupDataframeAnalyticsStatsDataCountsDeserializer(
ObjectDeserializer op) {
op.add(Builder::skippedDocsCount, JsonpDeserializer.integerDeserializer(), "skipped_docs_count");
op.add(Builder::testDocsCount, JsonpDeserializer.integerDeserializer(), "test_docs_count");
op.add(Builder::trainingDocsCount, JsonpDeserializer.integerDeserializer(), "training_docs_count");
}
}