Module org.elasticsearch.xcore

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

Class NullInferenceConfig

java.lang.Object

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

All Implemented Interfaces:

NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentObject, InferenceConfig, NamedXContentObject

public class NullInferenceConfig
extends Object
implements InferenceConfig

Used by ensemble to pass into sub-models.

Nested Class Summary

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 inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig

DEFAULT_RESULTS_FIELD, DEFAULT_TOP_CLASSES_RESULTS_FIELD, RESULTS_FIELD

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
NullInferenceConfig(boolean requestingFeatureImportance)

Method Summary

Modifier and Type	Method	Description
InferenceConfig	apply(InferenceConfigUpdate update)	Return a copy of this with the settings updated by the values in update.
MlConfigVersion	getMinimalSupportedMlConfigVersion()	All nodes in the cluster must have at least this MlConfigVersion attribute
TransportVersion	getMinimalSupportedTransportVersion()	All communication in the cluster must use at least this version
String	getName()
String	getResultsField()
String	getWriteableName()
boolean	isAllocateOnly()
boolean	isTargetTypeSupported(TargetType targetType)
boolean	requestingImportance()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.xpack.core.ml.inference.trainedmodel.InferenceConfig

getDefaultInput, getMinimalSupportedVersion, getMinLicenseSupported, getMinLicenseSupportedForAction, incompatibleUpdateException, supportsIngestPipeline, supportsPipelineAggregation, supportsSearchRescorer, validateTrainedModelInput

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

supportsVersion

Constructor Details

NullInferenceConfig

public NullInferenceConfig(boolean requestingFeatureImportance)

Method Details

isTargetTypeSupported

public boolean isTargetTypeSupported(TargetType targetType)

Specified by:

isTargetTypeSupported in interface InferenceConfig

apply

public InferenceConfig apply(InferenceConfigUpdate update)

Description copied from interface: InferenceConfig

Return a copy of this with the settings updated by the values in update.

Specified by:

apply in interface InferenceConfig

Parameters:

update - The update to apply

Returns:

A new updated config

getMinimalSupportedMlConfigVersion

public MlConfigVersion getMinimalSupportedMlConfigVersion()

Description copied from interface: InferenceConfig

All nodes in the cluster must have at least this MlConfigVersion attribute

Specified by:

getMinimalSupportedMlConfigVersion in interface InferenceConfig

getMinimalSupportedTransportVersion

public TransportVersion getMinimalSupportedTransportVersion()

Description copied from interface: InferenceConfig

All communication in the cluster must use at least this version

Specified by:

getMinimalSupportedTransportVersion in interface InferenceConfig

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

getName

public String getName()

Specified by:

getName in interface NamedXContentObject

Returns:

The name of the XContentObject that is to be serialized

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

requestingImportance

public boolean requestingImportance()

Specified by:

requestingImportance in interface InferenceConfig

isAllocateOnly

public boolean isAllocateOnly()

Specified by:

isAllocateOnly in interface InferenceConfig

getResultsField

public String getResultsField()

Specified by:

getResultsField in interface InferenceConfig