Package org.opensearch.ingest

Class IngestMetadata

java.lang.Object

org.opensearch.ingest.IngestMetadata

All Implemented Interfaces:

ClusterState.FeatureAware, Diffable<Metadata.Custom>, Metadata.Custom, NamedDiffable<Metadata.Custom>, org.opensearch.core.common.io.stream.NamedWriteable, org.opensearch.core.common.io.stream.VersionedNamedWriteable, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentFragment

public final class IngestMetadata
extends Object
implements Metadata.Custom

Holds the ingest pipelines that are available in the cluster

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.ToXContent

org.opensearch.core.xcontent.ToXContent.DelegatingMapParams, org.opensearch.core.xcontent.ToXContent.MapParams, org.opensearch.core.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.core.common.io.stream.Writeable

org.opensearch.core.common.io.stream.Writeable.Reader<V>, org.opensearch.core.common.io.stream.Writeable.WriteableRegistry, org.opensearch.core.common.io.stream.Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE

Fields inherited from interface org.opensearch.core.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
IngestMetadata(Map<String,PipelineConfiguration> pipelines)
IngestMetadata(org.opensearch.core.common.io.stream.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.opensearch.core.xcontent.XContentParser parser)
org.opensearch.Version	getMinimalSupportedVersion()
Map<String,PipelineConfiguration>	getPipelines()
String	getWriteableName()
int	hashCode()
static NamedDiff<Metadata.Custom>	readDiffFrom(org.opensearch.core.common.io.stream.StreamInput in)
org.opensearch.core.xcontent.XContentBuilder	toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
void	writeTo(org.opensearch.core.common.io.stream.StreamOutput out)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.cluster.ClusterState.FeatureAware

getRequiredFeature

Methods inherited from interface org.opensearch.core.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(org.opensearch.core.common.io.stream.StreamInput in)
               throws IOException

Throws:

IOException

Method Details

getWriteableName

public String getWriteableName()

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.NamedWriteable

Specified by:

getWriteableName in interface org.opensearch.core.common.io.stream.VersionedNamedWriteable

getMinimalSupportedVersion

public org.opensearch.Version getMinimalSupportedVersion()

Specified by:

getMinimalSupportedVersion in interface org.opensearch.core.common.io.stream.VersionedNamedWriteable

getPipelines

public Map<String,PipelineConfiguration> getPipelines()

writeTo

public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
             throws IOException

Specified by:

writeTo in interface org.opensearch.core.common.io.stream.Writeable

Throws:

IOException

fromXContent

public static IngestMetadata fromXContent(org.opensearch.core.xcontent.XContentParser parser)
                                   throws IOException

Throws:

IOException

toXContent

public org.opensearch.core.xcontent.XContentBuilder toXContent(org.opensearch.core.xcontent.XContentBuilder builder,
 org.opensearch.core.xcontent.ToXContent.Params params)
                                                        throws IOException

Specified by:

toXContent in interface org.opensearch.core.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(org.opensearch.core.common.io.stream.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