Class ExplainDataFrameAnalyticsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<BuilderT>
co.elastic.clients.elasticsearch._types.RequestBase.AbstractBuilder<ExplainDataFrameAnalyticsRequest.Builder>
co.elastic.clients.elasticsearch.ml.ExplainDataFrameAnalyticsRequest.Builder
- All Implemented Interfaces:
WithJson<ExplainDataFrameAnalyticsRequest.Builder>
,ObjectBuilder<ExplainDataFrameAnalyticsRequest>
- Enclosing class:
- ExplainDataFrameAnalyticsRequest
public static class ExplainDataFrameAnalyticsRequest.Builder
extends RequestBase.AbstractBuilder<ExplainDataFrameAnalyticsRequest.Builder>
implements ObjectBuilder<ExplainDataFrameAnalyticsRequest>
Builder for
ExplainDataFrameAnalyticsRequest
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionallowLazyStart
(Boolean value) Specifies whether this job can start when there is insufficient machine learning node capacity for it to be immediately assigned to a node.analysis
(DataframeAnalysis value) The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.Specify includes and/or excludes patterns to select which fields will be included in the analysis.analyzedFields
(Function<DataframeAnalysisAnalyzedFields.Builder, ObjectBuilder<DataframeAnalysisAnalyzedFields>> fn) Specify includes and/or excludes patterns to select which fields will be included in the analysis.build()
Builds aExplainDataFrameAnalyticsRequest
.description
(String value) A description of the job.The destination configuration, consisting of index and optionally results_field (ml by default).dest
(Function<DataframeAnalyticsDestination.Builder, ObjectBuilder<DataframeAnalyticsDestination>> fn) The destination configuration, consisting of index and optionally results_field (ml by default).Identifier for the data frame analytics job.maxNumThreads
(Integer value) The maximum number of threads to be used by the analysis.modelMemoryLimit
(String value) The approximate maximum amount of memory resources that are permitted for analytical processing.protected ExplainDataFrameAnalyticsRequest.Builder
self()
source
(DataframeAnalyticsSource value) The configuration of how to source the analysis data.The configuration of how to source the analysis data.Methods inherited from class co.elastic.clients.util.WithJsonObjectBuilderBase
withJson
Methods inherited from class co.elastic.clients.util.ObjectBuilderBase
_checkSingleUse, _listAdd, _listAddAll, _mapPut, _mapPutAll
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowLazyStart
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:
allow_lazy_start
-
analysis
The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.API name:
analysis
-
analysis
public final ExplainDataFrameAnalyticsRequest.Builder analysis(Function<DataframeAnalysis.Builder, ObjectBuilder<DataframeAnalysis>> fn) The analysis configuration, which contains the information necessary to perform one of the following types of analysis: classification, outlier detection, or regression.API name:
analysis
-
analyzedFields
public final ExplainDataFrameAnalyticsRequest.Builder analyzedFields(@Nullable DataframeAnalysisAnalyzedFields value) 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:
analyzed_fields
-
analyzedFields
public final ExplainDataFrameAnalyticsRequest.Builder analyzedFields(Function<DataframeAnalysisAnalyzedFields.Builder, ObjectBuilder<DataframeAnalysisAnalyzedFields>> fn) 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:
analyzed_fields
-
description
A description of the job.API name:
description
-
dest
public final ExplainDataFrameAnalyticsRequest.Builder dest(@Nullable DataframeAnalyticsDestination value) The destination configuration, consisting of index and optionally results_field (ml by default).API name:
dest
-
dest
public final ExplainDataFrameAnalyticsRequest.Builder dest(Function<DataframeAnalyticsDestination.Builder, ObjectBuilder<DataframeAnalyticsDestination>> fn) The destination configuration, consisting of index and optionally results_field (ml by default).API name:
dest
-
id
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:
id
-
maxNumThreads
The maximum number of threads to be used by the analysis. The default value is 1. 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:
max_num_threads
-
modelMemoryLimit
The approximate maximum amount of memory resources that are permitted for analytical processing. The default value for data frame analytics jobs is 1gb. 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:
model_memory_limit
-
source
public final ExplainDataFrameAnalyticsRequest.Builder source(@Nullable DataframeAnalyticsSource value) The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified.API name:
source
-
source
public final ExplainDataFrameAnalyticsRequest.Builder source(Function<DataframeAnalyticsSource.Builder, ObjectBuilder<DataframeAnalyticsSource>> fn) The configuration of how to source the analysis data. It requires an index. Optionally, query and _source may be specified.API name:
source
-
self
- Specified by:
self
in classRequestBase.AbstractBuilder<ExplainDataFrameAnalyticsRequest.Builder>
-
build
Builds aExplainDataFrameAnalyticsRequest
.- Specified by:
build
in interfaceObjectBuilder<ExplainDataFrameAnalyticsRequest>
- Throws:
NullPointerException
- if some of the required fields are null.
-