Module org.elasticsearch.xcore

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

Class FieldSelection

java.lang.Object

org.elasticsearch.xpack.core.ml.dataframe.explain.FieldSelection

All Implemented Interfaces:

Writeable, ToXContent, ToXContentObject

public class FieldSelection
extends Object
implements ToXContentObject, Writeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FieldSelection.FeatureType

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<FieldSelection,Void>	PARSER

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
FieldSelection(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static FieldSelection	excluded(String name, Set<String> mappingTypes, String reason)
FieldSelection.FeatureType	getFeatureType()
Set<String>	getMappingTypes()
String	getName()
String	getReason()
int	hashCode()
static FieldSelection	included(String name, Set<String> mappingTypes, boolean isRequired, FieldSelection.FeatureType featureType)
boolean	isIncluded()
boolean	isRequired()
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<FieldSelection,Void> PARSER

Constructor Details

FieldSelection

public FieldSelection(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

included

public static FieldSelection included(String name,
 Set<String> mappingTypes,
 boolean isRequired,
 FieldSelection.FeatureType featureType)

excluded

public static FieldSelection excluded(String name,
 Set<String> mappingTypes,
 String reason)

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getName

public String getName()

getMappingTypes

public Set<String> getMappingTypes()

isIncluded

public boolean isIncluded()

isRequired

public boolean isRequired()

getFeatureType

@Nullable
public FieldSelection.FeatureType getFeatureType()

getReason

@Nullable
public String getReason()