Module org.elasticsearch.xcore

Package org.elasticsearch.xpack.core.ml.inference.trainedmodel

Class ClassificationConfigUpdate

java.lang.Object

org.elasticsearch.xpack.core.ml.inference.trainedmodel.ClassificationConfigUpdate

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentObject, InferenceConfigUpdate, NamedXContentObject

public class ClassificationConfigUpdate
extends Object
implements InferenceConfigUpdate, NamedXContentObject

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ClassificationConfigUpdate.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 ClassificationConfigUpdate	EMPTY_PARAMS
static final ParseField	NAME

Fields inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfigUpdate

RESERVED_ML_FIELD_NAMES

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY

Constructor Summary

Constructors

Constructor	Description
ClassificationConfigUpdate(Integer numTopClasses, String resultsField, String topClassesResultsField, Integer featureImportance, PredictionFieldType predictionFieldType)
ClassificationConfigUpdate(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ClassificationConfigUpdate	fromConfig(ClassificationConfig config)
static ClassificationConfigUpdate	fromMap(Map<String,Object> map)
static ClassificationConfigUpdate	fromXContentStrict(XContentParser parser)
TransportVersion	getMinimalSupportedVersion()
String	getName()
Integer	getNumTopClasses()
Integer	getNumTopFeatureImportanceValues()
PredictionFieldType	getPredictionFieldType()
String	getResultsField()
String	getTopClassesResultsField()
String	getWriteableName()
int	hashCode()
boolean	isSupported(InferenceConfig inferenceConfig)
InferenceConfigUpdate.Builder<? extends InferenceConfigUpdate.Builder<?,?>,? extends InferenceConfigUpdate>	newBuilder()
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.xpack.core.ml.inference.trainedmodel.InferenceConfigUpdate

isEmpty

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

NAME

public static final ParseField NAME

EMPTY_PARAMS

public static final ClassificationConfigUpdate EMPTY_PARAMS

Constructor Details

ClassificationConfigUpdate

public ClassificationConfigUpdate(Integer numTopClasses,
 String resultsField,
 String topClassesResultsField,
 Integer featureImportance,
 PredictionFieldType predictionFieldType)

ClassificationConfigUpdate

public ClassificationConfigUpdate(StreamInput in)
                           throws IOException

Throws:

IOException

Method Details

fromMap

public static ClassificationConfigUpdate fromMap(Map<String,Object> map)

fromConfig

public static ClassificationConfigUpdate fromConfig(ClassificationConfig config)

fromXContentStrict

public static ClassificationConfigUpdate fromXContentStrict(XContentParser parser)

getNumTopClasses

public Integer getNumTopClasses()

getTopClassesResultsField

public String getTopClassesResultsField()

getResultsField

public String getResultsField()

Specified by:

getResultsField in interface InferenceConfigUpdate

newBuilder

public InferenceConfigUpdate.Builder<? extends InferenceConfigUpdate.Builder<?,?>,? extends InferenceConfigUpdate> newBuilder()

Specified by:

newBuilder in interface InferenceConfigUpdate

getNumTopFeatureImportanceValues

public Integer getNumTopFeatureImportanceValues()

getPredictionFieldType

public PredictionFieldType getPredictionFieldType()

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getName

public String getName()

Specified by:

getName in interface InferenceConfigUpdate

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized

isSupported

public boolean isSupported(InferenceConfig inferenceConfig)

Specified by:

isSupported in interface InferenceConfigUpdate

getMinimalSupportedVersion

public TransportVersion getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable