Package co.elastic.clients.elasticsearch.ml

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

Constructors

Constructor	Description
Builder()

Method Summary

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

Methods inherited from interface co.elastic.clients.json.WithJson

withJson, withJson

Constructor Details

Builder

public Builder()

Method Details

analysisStats

public final DataframeAnalytics.Builder analysisStats(@Nullable
 DataframeAnalyticsStats value)

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

analysisStats

public final DataframeAnalytics.Builder analysisStats(DataframeAnalyticsStatsVariant value)

An object containing information about the analysis job.

API name: analysis_stats

assignmentExplanation

public final DataframeAnalytics.Builder assignmentExplanation(@Nullable
 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 final 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 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

public final DataframeAnalytics.Builder id(String value)

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

API name: id

memoryUsage

public final 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 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

public final 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 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

public final DataframeAnalytics.Builder progress(List<DataframeAnalyticsStatsProgress> list)

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

API name: progress

Adds all elements of list to progress.

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

public final 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

self

protected DataframeAnalytics.Builder self()

Specified by:

self in class WithJsonObjectBuilderBase<DataframeAnalytics.Builder>

build

public DataframeAnalytics build()

Builds a DataframeAnalytics.

Specified by:

build in interface ObjectBuilder<DataframeAnalytics>

Throws:

NullPointerException - if some of the required fields are null.