Package co.elastic.clients.elasticsearch.ml

Class DataframeAnalytics.Builder

java.lang.Object

co.elastic.clients.elasticsearch.ml.DataframeAnalytics.Builder

All Implemented Interfaces:

ObjectBuilder<DataframeAnalytics>

Enclosing class:

DataframeAnalytics

public static class DataframeAnalytics.Builder
extends java.lang.Object
implements ObjectBuilder<DataframeAnalytics>

Builder for DataframeAnalytics.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
DataframeAnalytics.Builder	addProgress(DataframeAnalyticsStatsProgress value)	Add a value to progress(List), creating the list if needed.
DataframeAnalytics.Builder	addProgress(java.util.function.Function<DataframeAnalyticsStatsProgress.Builder,ObjectBuilder<DataframeAnalyticsStatsProgress>> fn)	Add a value to progress(List), creating the list if needed.
DataframeAnalytics.Builder	analysisStats(DataframeAnalyticsStats value)	An object containing information about the analysis job.
DataframeAnalytics.Builder	analysisStats(java.util.function.Function<DataframeAnalyticsStats.Builder,ObjectBuilder<DataframeAnalyticsStats>> fn)	An object containing information about the analysis job.
DataframeAnalytics.Builder	assignmentExplanation(java.lang.String value)	For running jobs only, contains messages relating to the selection of a node to run the job.
DataframeAnalytics	build()	Builds a DataframeAnalytics.
DataframeAnalytics.Builder	dataCounts(DataframeAnalyticsStatsDataCounts value)	Required - An object that provides counts for the quantity of documents skipped, used in training, or available for testing.
DataframeAnalytics.Builder	dataCounts(java.util.function.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.
DataframeAnalytics.Builder	id(java.lang.String value)	Required - The unique identifier of the data frame analytics job.
DataframeAnalytics.Builder	memoryUsage(DataframeAnalyticsStatsMemoryUsage value)	Required - An object describing memory usage of the analytics.
DataframeAnalytics.Builder	memoryUsage(java.util.function.Function<DataframeAnalyticsStatsMemoryUsage.Builder,ObjectBuilder<DataframeAnalyticsStatsMemoryUsage>> fn)	Required - An object describing memory usage of the analytics.
DataframeAnalytics.Builder	node(NodeAttributes value)	Contains properties for the node that runs the job.
DataframeAnalytics.Builder	node(java.util.function.Function<NodeAttributes.Builder,ObjectBuilder<NodeAttributes>> fn)	Contains properties for the node that runs the job.
DataframeAnalytics.Builder	progress(DataframeAnalyticsStatsProgress... value)	Required - The progress report of the data frame analytics job by phase.
DataframeAnalytics.Builder	progress(java.util.function.Function<DataframeAnalyticsStatsProgress.Builder,ObjectBuilder<DataframeAnalyticsStatsProgress>> fn)	Set progress(List) to a singleton list.
DataframeAnalytics.Builder	progress(java.util.List<DataframeAnalyticsStatsProgress> value)	Required - The progress report of the data frame analytics job by phase.
DataframeAnalytics.Builder	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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

analysisStats

public DataframeAnalytics.Builder analysisStats(@Nullable
DataframeAnalyticsStats value)

An object containing information about the analysis job.

API name: analysis_stats

analysisStats

public DataframeAnalytics.Builder analysisStats(java.util.function.Function<DataframeAnalyticsStats.Builder,ObjectBuilder<DataframeAnalyticsStats>> fn)

An object containing information about the analysis job.

API name: analysis_stats

assignmentExplanation

public DataframeAnalytics.Builder assignmentExplanation(@Nullable
java.lang.String value)

For running jobs only, contains messages relating to the selection of a node to run the job.

API name: assignment_explanation

dataCounts

public DataframeAnalytics.Builder dataCounts(DataframeAnalyticsStatsDataCounts value)

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 DataframeAnalytics.Builder dataCounts(java.util.function.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

public DataframeAnalytics.Builder id(java.lang.String value)

Required - The unique identifier of the data frame analytics job.

API name: id

memoryUsage

public DataframeAnalytics.Builder memoryUsage(DataframeAnalyticsStatsMemoryUsage value)

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 DataframeAnalytics.Builder memoryUsage(java.util.function.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

public DataframeAnalytics.Builder node(@Nullable
NodeAttributes value)

Contains properties for the node that runs the job. This information is available only for running jobs.

API name: node

node

public DataframeAnalytics.Builder node(java.util.function.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

public DataframeAnalytics.Builder progress(java.util.List<DataframeAnalyticsStatsProgress> value)

Required - The progress report of the data frame analytics job by phase.

API name: progress

progress

public DataframeAnalytics.Builder progress(DataframeAnalyticsStatsProgress... value)

Required - The progress report of the data frame analytics job by phase.

API name: progress

addProgress

public DataframeAnalytics.Builder addProgress(DataframeAnalyticsStatsProgress value)

Add a value to progress(List), creating the list if needed.

progress

public DataframeAnalytics.Builder progress(java.util.function.Function<DataframeAnalyticsStatsProgress.Builder,ObjectBuilder<DataframeAnalyticsStatsProgress>> fn)

Set progress(List) to a singleton list.

addProgress

public DataframeAnalytics.Builder addProgress(java.util.function.Function<DataframeAnalyticsStatsProgress.Builder,ObjectBuilder<DataframeAnalyticsStatsProgress>> fn)

Add a value to progress(List), creating the list if needed.

state

public DataframeAnalytics.Builder 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.

API name: state

build

public DataframeAnalytics build()

Builds a DataframeAnalytics.

Specified by:

build in interface ObjectBuilder<DataframeAnalytics>

Throws:

java.lang.NullPointerException - if some of the required fields are null.