Package org.elasticsearch.ingest

Class IngestMetadata

java.lang.Object

org.elasticsearch.ingest.IngestMetadata

All Implemented Interfaces:

ClusterState.FeatureAware, Diffable<Metadata.Custom>, Metadata.Custom, NamedDiffable<Metadata.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment

public final class IngestMetadata
extends Object
implements Metadata.Custom

Holds the ingest pipelines that are available in the cluster

Nested Class Summary

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 String	TYPE

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
IngestMetadata(Map<String,PipelineConfiguration> pipelines)
IngestMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
Diff<Metadata.Custom>	diff(Metadata.Custom before)	Returns serializable object representing differences between this and previousState
boolean	equals(Object o)
static IngestMetadata	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
Map<String,PipelineConfiguration>	getPipelines()
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static NamedDiff<Metadata.Custom>	readDiffFrom(StreamInput in)
org.elasticsearch.common.xcontent.XContentBuilder	toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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.ClusterState.FeatureAware

getRequiredFeature

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentFragment

isFragment

Field Details

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Details

IngestMetadata

public IngestMetadata(Map<String,PipelineConfiguration> pipelines)

IngestMetadata

public IngestMetadata(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

getPipelines

public Map<String,PipelineConfiguration> getPipelines()

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

fromXContent

public static IngestMetadata fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                   throws IOException

Throws:

IOException

toXContent

public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                                                             throws IOException

Specified by:

toXContent in interface org.elasticsearch.common.xcontent.ToXContent

Throws:

IOException

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.Custom

diff

public Diff<Metadata.Custom> diff(Metadata.Custom before)

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<Metadata.Custom>

readDiffFrom

public static NamedDiff<Metadata.Custom> readDiffFrom(StreamInput in)
                                               throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object