Class ExplainDataFrameAnalyticsRequest.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<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 WithJsonObjectBuilderBase<ExplainDataFrameAnalyticsRequest.Builder> implements ObjectBuilder<ExplainDataFrameAnalyticsRequest>
Builder for
ExplainDataFrameAnalyticsRequest
.-
Constructor Summary
Constructors Constructor Description Builder()
-
Method Summary
Modifier and Type Method Description ExplainDataFrameAnalyticsRequest.Builder
allowLazyStart(java.lang.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.ExplainDataFrameAnalyticsRequest.Builder
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.ExplainDataFrameAnalyticsRequest.Builder
analysis(java.util.function.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.ExplainDataFrameAnalyticsRequest.Builder
analyzedFields(DataframeAnalysisAnalyzedFields value)
Specify includes and/or excludes patterns to select which fields will be included in the analysis.ExplainDataFrameAnalyticsRequest.Builder
analyzedFields(java.util.function.Function<DataframeAnalysisAnalyzedFields.Builder,ObjectBuilder<DataframeAnalysisAnalyzedFields>> fn)
Specify includes and/or excludes patterns to select which fields will be included in the analysis.ExplainDataFrameAnalyticsRequest
build()
Builds aExplainDataFrameAnalyticsRequest
.ExplainDataFrameAnalyticsRequest.Builder
description(java.lang.String value)
A description of the job.ExplainDataFrameAnalyticsRequest.Builder
dest(DataframeAnalyticsDestination value)
The destination configuration, consisting of index and optionally results_field (ml by default).ExplainDataFrameAnalyticsRequest.Builder
dest(java.util.function.Function<DataframeAnalyticsDestination.Builder,ObjectBuilder<DataframeAnalyticsDestination>> fn)
The destination configuration, consisting of index and optionally results_field (ml by default).ExplainDataFrameAnalyticsRequest.Builder
id(java.lang.String value)
Identifier for the data frame analytics job.ExplainDataFrameAnalyticsRequest.Builder
maxNumThreads(java.lang.Integer value)
The maximum number of threads to be used by the analysis.ExplainDataFrameAnalyticsRequest.Builder
modelMemoryLimit(java.lang.String value)
The approximate maximum amount of memory resources that are permitted for analytical processing.protected ExplainDataFrameAnalyticsRequest.Builder
self()
ExplainDataFrameAnalyticsRequest.Builder
source(DataframeAnalyticsSource value)
The configuration of how to source the analysis data.ExplainDataFrameAnalyticsRequest.Builder
source(java.util.function.Function<DataframeAnalyticsSource.Builder,ObjectBuilder<DataframeAnalyticsSource>> fn)
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
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowLazyStart
public final ExplainDataFrameAnalyticsRequest.Builder allowLazyStart(@Nullable java.lang.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.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(java.util.function.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(java.util.function.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
public final ExplainDataFrameAnalyticsRequest.Builder description(@Nullable java.lang.String value)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(java.util.function.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
public final ExplainDataFrameAnalyticsRequest.Builder maxNumThreads(@Nullable java.lang.Integer value)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:
max_num_threads
-
modelMemoryLimit
public final ExplainDataFrameAnalyticsRequest.Builder modelMemoryLimit(@Nullable java.lang.String value)The approximate maximum amount of memory resources that are permitted for analytical processing. If yourelasticsearch.yml
file contains anxpack.ml.max_model_memory_limit
setting, an error occurs when you try to create data frame analytics jobs that havemodel_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(java.util.function.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 classWithJsonObjectBuilderBase<ExplainDataFrameAnalyticsRequest.Builder>
-
build
Builds aExplainDataFrameAnalyticsRequest
.- Specified by:
build
in interfaceObjectBuilder<ExplainDataFrameAnalyticsRequest>
- Throws:
java.lang.NullPointerException
- if some of the required fields are null.
-