co.elastic.clients.elasticsearch.ml.ExplainDataFrameAnalyticsResponse 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.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.explain_data_frame_analytics.Response
/**
*
* @see API
* specification
*/
@JsonpDeserializable
public class ExplainDataFrameAnalyticsResponse implements JsonpSerializable {
private final List fieldSelection;
private final DataframeAnalyticsMemoryEstimation memoryEstimation;
// ---------------------------------------------------------------------------------------------
private ExplainDataFrameAnalyticsResponse(Builder builder) {
this.fieldSelection = ApiTypeHelper.unmodifiableRequired(builder.fieldSelection, this, "fieldSelection");
this.memoryEstimation = ApiTypeHelper.requireNonNull(builder.memoryEstimation, this, "memoryEstimation");
}
public static ExplainDataFrameAnalyticsResponse of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Required - An array of objects that explain selection for each field, sorted
* by the field names.
*
* API name: {@code field_selection}
*/
public final List fieldSelection() {
return this.fieldSelection;
}
/**
* Required - An array of objects that explain selection for each field, sorted
* by the field names.
*
* API name: {@code memory_estimation}
*/
public final DataframeAnalyticsMemoryEstimation memoryEstimation() {
return this.memoryEstimation;
}
/**
* 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 (ApiTypeHelper.isDefined(this.fieldSelection)) {
generator.writeKey("field_selection");
generator.writeStartArray();
for (DataframeAnalyticsFieldSelection item0 : this.fieldSelection) {
item0.serialize(generator, mapper);
}
generator.writeEnd();
}
generator.writeKey("memory_estimation");
this.memoryEstimation.serialize(generator, mapper);
}
@Override
public String toString() {
return JsonpUtils.toString(this);
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ExplainDataFrameAnalyticsResponse}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
private List fieldSelection;
private DataframeAnalyticsMemoryEstimation memoryEstimation;
/**
* Required - An array of objects that explain selection for each field, sorted
* by the field names.
*
* API name: {@code field_selection}
*
* Adds all elements of list to fieldSelection.
*/
public final Builder fieldSelection(List list) {
this.fieldSelection = _listAddAll(this.fieldSelection, list);
return this;
}
/**
* Required - An array of objects that explain selection for each field, sorted
* by the field names.
*
* API name: {@code field_selection}
*
* Adds one or more values to fieldSelection.
*/
public final Builder fieldSelection(DataframeAnalyticsFieldSelection value,
DataframeAnalyticsFieldSelection... values) {
this.fieldSelection = _listAdd(this.fieldSelection, value, values);
return this;
}
/**
* Required - An array of objects that explain selection for each field, sorted
* by the field names.
*
* API name: {@code field_selection}
*
* Adds a value to fieldSelection using a builder lambda.
*/
public final Builder fieldSelection(
Function> fn) {
return fieldSelection(fn.apply(new DataframeAnalyticsFieldSelection.Builder()).build());
}
/**
* Required - An array of objects that explain selection for each field, sorted
* by the field names.
*
* API name: {@code memory_estimation}
*/
public final Builder memoryEstimation(DataframeAnalyticsMemoryEstimation value) {
this.memoryEstimation = value;
return this;
}
/**
* Required - An array of objects that explain selection for each field, sorted
* by the field names.
*
* API name: {@code memory_estimation}
*/
public final Builder memoryEstimation(
Function> fn) {
return this.memoryEstimation(fn.apply(new DataframeAnalyticsMemoryEstimation.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link ExplainDataFrameAnalyticsResponse}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ExplainDataFrameAnalyticsResponse build() {
_checkSingleUse();
return new ExplainDataFrameAnalyticsResponse(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ExplainDataFrameAnalyticsResponse}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, ExplainDataFrameAnalyticsResponse::setupExplainDataFrameAnalyticsResponseDeserializer);
protected static void setupExplainDataFrameAnalyticsResponseDeserializer(
ObjectDeserializer op) {
op.add(Builder::fieldSelection,
JsonpDeserializer.arrayDeserializer(DataframeAnalyticsFieldSelection._DESERIALIZER), "field_selection");
op.add(Builder::memoryEstimation, DataframeAnalyticsMemoryEstimation._DESERIALIZER, "memory_estimation");
}
}