Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.dataframe

Class DataFrameAnalyticsConfigUpdate

java.lang.Object

org.elasticsearch.xpack.core.ml.dataframe.DataFrameAnalyticsConfigUpdate

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class DataFrameAnalyticsConfigUpdate
extends Object
implements Writeable, ToXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DataFrameAnalyticsConfigUpdate.Builder

Nested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final ConstructingObjectParser<DataFrameAnalyticsConfigUpdate.Builder,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
DataFrameAnalyticsConfigUpdate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object other)
String	getDescription()
String	getId()
Integer	getMaxNumThreads()
Map<String,Object>	getMeta()
ByteSizeValue	getModelMemoryLimit()
Set<String>	getUpdatedFields()
int	hashCode()
Boolean	isAllowLazyStart()
DataFrameAnalyticsConfig.Builder	mergeWithConfig(DataFrameAnalyticsConfig source)	Updates source with the new values in this object returning a new DataFrameAnalyticsConfig.
boolean	requiresRestart(DataFrameAnalyticsConfig source)	Whether this update applied to the given source config requires analytics task restart.
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

PARSER

public static final ConstructingObjectParser<DataFrameAnalyticsConfigUpdate.Builder,Void> PARSER

Constructor Details

DataFrameAnalyticsConfigUpdate

public DataFrameAnalyticsConfigUpdate(StreamInput in)
                               throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getId

public String getId()

getDescription

public String getDescription()

getModelMemoryLimit

public ByteSizeValue getModelMemoryLimit()

isAllowLazyStart

public Boolean isAllowLazyStart()

getMaxNumThreads

public Integer getMaxNumThreads()

getMeta

public Map<String,Object> getMeta()

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

mergeWithConfig

public DataFrameAnalyticsConfig.Builder mergeWithConfig(DataFrameAnalyticsConfig source)

Updates source with the new values in this object returning a new DataFrameAnalyticsConfig.

Parameters:

source - Source config to be updated

Returns:

A new config equivalent to source updated.

requiresRestart

public boolean requiresRestart(DataFrameAnalyticsConfig source)

Whether this update applied to the given source config requires analytics task restart.

getUpdatedFields

public Set<String> getUpdatedFields()

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object