co.elastic.clients.elasticsearch.ml.ExplainDataFrameAnalyticsRequest 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.ErrorResponse;
import co.elastic.clients.elasticsearch._types.RequestBase;
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.transport.Endpoint;
import co.elastic.clients.transport.endpoints.SimpleEndpoint;
import co.elastic.clients.util.ObjectBuilder;
import co.elastic.clients.util.WithJsonObjectBuilderBase;
import jakarta.json.stream.JsonGenerator;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.Collections;
import java.util.Objects;
import java.util.function.Function;
import javax.annotation.Nullable;
// typedef: ml.explain_data_frame_analytics.Request
/**
* Explains a data frame analytics config. This API provides explanations for a
* data frame analytics config that either exists already or one that has not
* been created yet. The following explanations are provided:
*
* - which fields are included or not in the analysis and why,
* - how much memory is estimated to be required. The estimate can be used
* when deciding the appropriate value for model_memory_limit setting later on.
* If you have object fields or fields that are excluded via source filtering,
* they are not included in the explanation.
*
*
* @see API
* specification
*/
@JsonpDeserializable
public class ExplainDataFrameAnalyticsRequest extends RequestBase implements JsonpSerializable {
@Nullable
private final Boolean allowLazyStart;
@Nullable
private final DataframeAnalysis analysis;
@Nullable
private final DataframeAnalysisAnalyzedFields analyzedFields;
@Nullable
private final String description;
@Nullable
private final DataframeAnalyticsDestination dest;
@Nullable
private final String id;
@Nullable
private final Integer maxNumThreads;
@Nullable
private final String modelMemoryLimit;
@Nullable
private final DataframeAnalyticsSource source;
// ---------------------------------------------------------------------------------------------
private ExplainDataFrameAnalyticsRequest(Builder builder) {
this.allowLazyStart = builder.allowLazyStart;
this.analysis = builder.analysis;
this.analyzedFields = builder.analyzedFields;
this.description = builder.description;
this.dest = builder.dest;
this.id = builder.id;
this.maxNumThreads = builder.maxNumThreads;
this.modelMemoryLimit = builder.modelMemoryLimit;
this.source = builder.source;
}
public static ExplainDataFrameAnalyticsRequest of(
Function> fn) {
return fn.apply(new Builder()).build();
}
/**
* Specifies whether this job can start when there is insufficient machine
* learning node capacity for it to be immediately assigned to a node.
*
* API name: {@code allow_lazy_start}
*/
@Nullable
public final Boolean allowLazyStart() {
return this.allowLazyStart;
}
/**
* The analysis configuration, which contains the information necessary to
* perform one of the following types of analysis: classification, outlier
* detection, or regression.
*
* API name: {@code analysis}
*/
@Nullable
public final DataframeAnalysis analysis() {
return this.analysis;
}
/**
* Specify includes and/or excludes patterns to select which fields will be
* included in the analysis. The patterns specified in excludes are applied
* last, therefore excludes takes precedence. In other words, if the same field
* is specified in both includes and excludes, then the field will not be
* included in the analysis.
*
* API name: {@code analyzed_fields}
*/
@Nullable
public final DataframeAnalysisAnalyzedFields analyzedFields() {
return this.analyzedFields;
}
/**
* A description of the job.
*
* API name: {@code description}
*/
@Nullable
public final String description() {
return this.description;
}
/**
* The destination configuration, consisting of index and optionally
* results_field (ml by default).
*
* API name: {@code dest}
*/
@Nullable
public final DataframeAnalyticsDestination dest() {
return this.dest;
}
/**
* Identifier for the data frame analytics job. This identifier can contain
* lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
* must start and end with alphanumeric characters.
*
* API name: {@code id}
*/
@Nullable
public final String id() {
return this.id;
}
/**
* The maximum number of threads to be used by the analysis. Using more threads
* may decrease the time necessary to complete the analysis at the cost of using
* more CPU. Note that the process may use additional threads for operational
* functionality other than the analysis itself.
*
* API name: {@code max_num_threads}
*/
@Nullable
public final Integer maxNumThreads() {
return this.maxNumThreads;
}
/**
* The approximate maximum amount of memory resources that are permitted for
* analytical processing. If your elasticsearch.yml file contains
* an xpack.ml.max_model_memory_limit setting, an error occurs when
* you try to create data frame analytics jobs that have
* model_memory_limit values greater than that setting.
*
* API name: {@code model_memory_limit}
*/
@Nullable
public final String modelMemoryLimit() {
return this.modelMemoryLimit;
}
/**
* The configuration of how to source the analysis data. It requires an index.
* Optionally, query and _source may be specified.
*
* API name: {@code source}
*/
@Nullable
public final DataframeAnalyticsSource source() {
return this.source;
}
/**
* 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.allowLazyStart != null) {
generator.writeKey("allow_lazy_start");
generator.write(this.allowLazyStart);
}
if (this.analysis != null) {
generator.writeKey("analysis");
this.analysis.serialize(generator, mapper);
}
if (this.analyzedFields != null) {
generator.writeKey("analyzed_fields");
this.analyzedFields.serialize(generator, mapper);
}
if (this.description != null) {
generator.writeKey("description");
generator.write(this.description);
}
if (this.dest != null) {
generator.writeKey("dest");
this.dest.serialize(generator, mapper);
}
if (this.maxNumThreads != null) {
generator.writeKey("max_num_threads");
generator.write(this.maxNumThreads);
}
if (this.modelMemoryLimit != null) {
generator.writeKey("model_memory_limit");
generator.write(this.modelMemoryLimit);
}
if (this.source != null) {
generator.writeKey("source");
this.source.serialize(generator, mapper);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Builder for {@link ExplainDataFrameAnalyticsRequest}.
*/
public static class Builder extends WithJsonObjectBuilderBase
implements
ObjectBuilder {
@Nullable
private Boolean allowLazyStart;
@Nullable
private DataframeAnalysis analysis;
@Nullable
private DataframeAnalysisAnalyzedFields analyzedFields;
@Nullable
private String description;
@Nullable
private DataframeAnalyticsDestination dest;
@Nullable
private String id;
@Nullable
private Integer maxNumThreads;
@Nullable
private String modelMemoryLimit;
@Nullable
private DataframeAnalyticsSource source;
/**
* Specifies whether this job can start when there is insufficient machine
* learning node capacity for it to be immediately assigned to a node.
*
* API name: {@code allow_lazy_start}
*/
public final Builder allowLazyStart(@Nullable Boolean value) {
this.allowLazyStart = value;
return this;
}
/**
* The analysis configuration, which contains the information necessary to
* perform one of the following types of analysis: classification, outlier
* detection, or regression.
*
* API name: {@code analysis}
*/
public final Builder analysis(@Nullable DataframeAnalysis value) {
this.analysis = value;
return this;
}
/**
* The analysis configuration, which contains the information necessary to
* perform one of the following types of analysis: classification, outlier
* detection, or regression.
*
* API name: {@code analysis}
*/
public final Builder analysis(Function> fn) {
return this.analysis(fn.apply(new DataframeAnalysis.Builder()).build());
}
/**
* Specify includes and/or excludes patterns to select which fields will be
* included in the analysis. The patterns specified in excludes are applied
* last, therefore excludes takes precedence. In other words, if the same field
* is specified in both includes and excludes, then the field will not be
* included in the analysis.
*
* API name: {@code analyzed_fields}
*/
public final Builder analyzedFields(@Nullable DataframeAnalysisAnalyzedFields value) {
this.analyzedFields = value;
return this;
}
/**
* Specify includes and/or excludes patterns to select which fields will be
* included in the analysis. The patterns specified in excludes are applied
* last, therefore excludes takes precedence. In other words, if the same field
* is specified in both includes and excludes, then the field will not be
* included in the analysis.
*
* API name: {@code analyzed_fields}
*/
public final Builder analyzedFields(
Function> fn) {
return this.analyzedFields(fn.apply(new DataframeAnalysisAnalyzedFields.Builder()).build());
}
/**
* A description of the job.
*
* API name: {@code description}
*/
public final Builder description(@Nullable String value) {
this.description = value;
return this;
}
/**
* The destination configuration, consisting of index and optionally
* results_field (ml by default).
*
* API name: {@code dest}
*/
public final Builder dest(@Nullable DataframeAnalyticsDestination value) {
this.dest = value;
return this;
}
/**
* The destination configuration, consisting of index and optionally
* results_field (ml by default).
*
* API name: {@code dest}
*/
public final Builder dest(
Function> fn) {
return this.dest(fn.apply(new DataframeAnalyticsDestination.Builder()).build());
}
/**
* Identifier for the data frame analytics job. This identifier can contain
* lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
* must start and end with alphanumeric characters.
*
* API name: {@code id}
*/
public final Builder id(@Nullable String value) {
this.id = value;
return this;
}
/**
* The maximum number of threads to be used by the analysis. Using more threads
* may decrease the time necessary to complete the analysis at the cost of using
* more CPU. Note that the process may use additional threads for operational
* functionality other than the analysis itself.
*
* API name: {@code max_num_threads}
*/
public final Builder maxNumThreads(@Nullable Integer value) {
this.maxNumThreads = value;
return this;
}
/**
* The approximate maximum amount of memory resources that are permitted for
* analytical processing. If your elasticsearch.yml file contains
* an xpack.ml.max_model_memory_limit setting, an error occurs when
* you try to create data frame analytics jobs that have
* model_memory_limit values greater than that setting.
*
* API name: {@code model_memory_limit}
*/
public final Builder modelMemoryLimit(@Nullable String value) {
this.modelMemoryLimit = value;
return this;
}
/**
* The configuration of how to source the analysis data. It requires an index.
* Optionally, query and _source may be specified.
*
* API name: {@code source}
*/
public final Builder source(@Nullable DataframeAnalyticsSource value) {
this.source = value;
return this;
}
/**
* The configuration of how to source the analysis data. It requires an index.
* Optionally, query and _source may be specified.
*
* API name: {@code source}
*/
public final Builder source(
Function> fn) {
return this.source(fn.apply(new DataframeAnalyticsSource.Builder()).build());
}
@Override
protected Builder self() {
return this;
}
/**
* Builds a {@link ExplainDataFrameAnalyticsRequest}.
*
* @throws NullPointerException
* if some of the required fields are null.
*/
public ExplainDataFrameAnalyticsRequest build() {
_checkSingleUse();
return new ExplainDataFrameAnalyticsRequest(this);
}
}
// ---------------------------------------------------------------------------------------------
/**
* Json deserializer for {@link ExplainDataFrameAnalyticsRequest}
*/
public static final JsonpDeserializer _DESERIALIZER = ObjectBuilderDeserializer
.lazy(Builder::new, ExplainDataFrameAnalyticsRequest::setupExplainDataFrameAnalyticsRequestDeserializer);
protected static void setupExplainDataFrameAnalyticsRequestDeserializer(
ObjectDeserializer op) {
op.add(Builder::allowLazyStart, JsonpDeserializer.booleanDeserializer(), "allow_lazy_start");
op.add(Builder::analysis, DataframeAnalysis._DESERIALIZER, "analysis");
op.add(Builder::analyzedFields, DataframeAnalysisAnalyzedFields._DESERIALIZER, "analyzed_fields");
op.add(Builder::description, JsonpDeserializer.stringDeserializer(), "description");
op.add(Builder::dest, DataframeAnalyticsDestination._DESERIALIZER, "dest");
op.add(Builder::maxNumThreads, JsonpDeserializer.integerDeserializer(), "max_num_threads");
op.add(Builder::modelMemoryLimit, JsonpDeserializer.stringDeserializer(), "model_memory_limit");
op.add(Builder::source, DataframeAnalyticsSource._DESERIALIZER, "source");
}
// ---------------------------------------------------------------------------------------------
/**
* Endpoint "{@code ml.explain_data_frame_analytics}".
*/
public static final Endpoint _ENDPOINT = new SimpleEndpoint<>(
"es/ml.explain_data_frame_analytics",
// Request method
request -> {
return "POST";
},
// Request path
request -> {
final int _id = 1 << 0;
int propsSet = 0;
if (request.id() != null)
propsSet |= _id;
if (propsSet == 0) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/data_frame");
buf.append("/analytics");
buf.append("/_explain");
return buf.toString();
}
if (propsSet == (_id)) {
StringBuilder buf = new StringBuilder();
buf.append("/_ml");
buf.append("/data_frame");
buf.append("/analytics");
buf.append("/");
SimpleEndpoint.pathEncode(request.id, buf);
buf.append("/_explain");
return buf.toString();
}
throw SimpleEndpoint.noPathTemplateFound("path");
},
// Request parameters
request -> {
return Collections.emptyMap();
}, SimpleEndpoint.emptyMap(), true, ExplainDataFrameAnalyticsResponse._DESERIALIZER);
}