Class DataframeAnalytics.Builder
java.lang.Object
co.elastic.clients.util.ObjectBuilderBase
co.elastic.clients.util.WithJsonObjectBuilderBase<DataframeAnalytics.Builder>
co.elastic.clients.elasticsearch.ml.DataframeAnalytics.Builder
- All Implemented Interfaces:
WithJson<DataframeAnalytics.Builder>
,ObjectBuilder<DataframeAnalytics>
- Enclosing class:
- DataframeAnalytics
public static class DataframeAnalytics.Builder
extends WithJsonObjectBuilderBase<DataframeAnalytics.Builder>
implements ObjectBuilder<DataframeAnalytics>
Builder for
DataframeAnalytics
.-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionAn object containing information about the analysis job.An object containing information about the analysis job.assignmentExplanation
(String value) For running jobs only, contains messages relating to the selection of a node to run the job.build()
Builds aDataframeAnalytics
.Required - An object that provides counts for the quantity of documents skipped, used in training, or available for testing.dataCounts
(Function<DataframeAnalyticsStatsDataCounts.Builder, ObjectBuilder<DataframeAnalyticsStatsDataCounts>> fn) Required - An object that provides counts for the quantity of documents skipped, used in training, or available for testing.Required - The unique identifier of the data frame analytics job.Required - An object describing memory usage of the analytics.memoryUsage
(Function<DataframeAnalyticsStatsMemoryUsage.Builder, ObjectBuilder<DataframeAnalyticsStatsMemoryUsage>> fn) Required - An object describing memory usage of the analytics.node
(NodeAttributes value) Contains properties for the node that runs the job.Contains properties for the node that runs the job.progress
(DataframeAnalyticsStatsProgress value, DataframeAnalyticsStatsProgress... values) Required - The progress report of the data frame analytics job by phase.progress
(Function<DataframeAnalyticsStatsProgress.Builder, ObjectBuilder<DataframeAnalyticsStatsProgress>> fn) Required - The progress report of the data frame analytics job by phase.Required - The progress report of the data frame analytics job by phase.protected DataframeAnalytics.Builder
self()
state
(DataframeState value) Required - The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.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
-
analysisStats
An object containing information about the analysis job.API name:
analysis_stats
-
analysisStats
public final DataframeAnalytics.Builder analysisStats(Function<DataframeAnalyticsStats.Builder, ObjectBuilder<DataframeAnalyticsStats>> fn) An object containing information about the analysis job.API name:
analysis_stats
-
assignmentExplanation
For running jobs only, contains messages relating to the selection of a node to run the job.API name:
assignment_explanation
-
dataCounts
Required - An object that provides counts for the quantity of documents skipped, used in training, or available for testing.API name:
data_counts
-
dataCounts
public final DataframeAnalytics.Builder dataCounts(Function<DataframeAnalyticsStatsDataCounts.Builder, ObjectBuilder<DataframeAnalyticsStatsDataCounts>> fn) Required - An object that provides counts for the quantity of documents skipped, used in training, or available for testing.API name:
data_counts
-
id
Required - The unique identifier of the data frame analytics job.API name:
id
-
memoryUsage
Required - An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.API name:
memory_usage
-
memoryUsage
public final DataframeAnalytics.Builder memoryUsage(Function<DataframeAnalyticsStatsMemoryUsage.Builder, ObjectBuilder<DataframeAnalyticsStatsMemoryUsage>> fn) Required - An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.API name:
memory_usage
-
node
Contains properties for the node that runs the job. This information is available only for running jobs.API name:
node
-
node
public final DataframeAnalytics.Builder node(Function<NodeAttributes.Builder, ObjectBuilder<NodeAttributes>> fn) Contains properties for the node that runs the job. This information is available only for running jobs.API name:
node
-
progress
Required - The progress report of the data frame analytics job by phase.API name:
progress
Adds all elements of
list
toprogress
. -
progress
public final DataframeAnalytics.Builder progress(DataframeAnalyticsStatsProgress value, DataframeAnalyticsStatsProgress... values) Required - The progress report of the data frame analytics job by phase.API name:
progress
Adds one or more values to
progress
. -
progress
public final DataframeAnalytics.Builder progress(Function<DataframeAnalyticsStatsProgress.Builder, ObjectBuilder<DataframeAnalyticsStatsProgress>> fn) Required - The progress report of the data frame analytics job by phase.API name:
progress
Adds a value to
progress
using a builder lambda. -
state
Required - The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.API name:
state
-
self
- Specified by:
self
in classWithJsonObjectBuilderBase<DataframeAnalytics.Builder>
-
build
Builds aDataframeAnalytics
.- Specified by:
build
in interfaceObjectBuilder<DataframeAnalytics>
- Throws:
NullPointerException
- if some of the required fields are null.
-