Module org.elasticsearch.server

Package org.elasticsearch.cluster.metadata

Class InferenceFieldMetadata

java.lang.Object

org.elasticsearch.cluster.metadata.InferenceFieldMetadata

All Implemented Interfaces:

Diffable<InferenceFieldMetadata>, SimpleDiffable<InferenceFieldMetadata>, Writeable, ToXContent, ToXContentFragment

public final class InferenceFieldMetadata
extends Object
implements SimpleDiffable<InferenceFieldMetadata>, ToXContentFragment

Contains inference field data for fields. As inference is done in the coordinator node to avoid re-doing it at shard / replica level, the coordinator needs to check for the need to perform inference for specific fields in an index. Given that the coordinator node does not necessarily have mapping information for all indices (only for those that have shards in the node), the field inference information must be stored in the IndexMetadata and broadcasted to all nodes.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.cluster.SimpleDiffable

SimpleDiffable.CompleteDiff<T extends Diffable<T>>

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.cluster.SimpleDiffable

EMPTY

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY, EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
InferenceFieldMetadata(String name, String inferenceId, String[] sourceFields)
InferenceFieldMetadata(StreamInput input)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static InferenceFieldMetadata	fromXContent(XContentParser parser)
String	getInferenceId()
String	getName()
String[]	getSourceFields()
int	hashCode()
static Diff<InferenceFieldMetadata>	readDiffFrom(StreamInput in)
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.elasticsearch.cluster.SimpleDiffable

diff

Methods inherited from interface org.elasticsearch.xcontent.ToXContentFragment

isFragment

Constructor Details

InferenceFieldMetadata

public InferenceFieldMetadata(String name,
 String inferenceId,
 String[] sourceFields)

InferenceFieldMetadata

public InferenceFieldMetadata(StreamInput input)
                       throws IOException

Throws:

IOException

Method Details

writeTo

public void writeTo(StreamOutput out)
             throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

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

getName

public String getName()

getInferenceId

public String getInferenceId()

getSourceFields

public String[] getSourceFields()

readDiffFrom

public static Diff<InferenceFieldMetadata> readDiffFrom(StreamInput in)
                                                 throws IOException

Throws:

IOException

toXContent

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

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static InferenceFieldMetadata fromXContent(XContentParser parser)
                                           throws IOException

Throws:

IOException