Package org.elasticsearch.script

Class ScriptMetaData

java.lang.Object

org.elasticsearch.script.ScriptMetaData

All Implemented Interfaces:

ClusterState.FeatureAware, Diffable<MetaData.Custom>, MetaData.Custom, NamedDiffable<MetaData.Custom>, NamedWriteable, VersionedNamedWriteable, Writeable, ToXContent, ToXContentFragment

public final class ScriptMetaData
extends Object
implements MetaData.Custom, Writeable, ToXContentFragment

ScriptMetaData is used to store user-defined scripts as part of the ClusterState using only an id as the key.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptMetaData.Builder	A builder used to modify the currently stored scripts data held within the ClusterState.

Nested classes/interfaces inherited from interface org.elasticsearch.common.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 String	TYPE	The type of ClusterState data.

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ScriptMetaData(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 ScriptMetaData	fromXContent(XContentParser parser)	This will parse XContent into ScriptMetaData.
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getWriteableName()	Returns the name of the writeable object
int	hashCode()
static NamedDiff<MetaData.Custom>	readDiffFrom(StreamInput in)
String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)	This will write XContent from ScriptMetaData.
void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

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

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

getRequiredFeature

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

isFragment

Field Detail

TYPE

public static final String TYPE

The type of ClusterState data.

See Also:

Constant Field Values

Constructor Detail

ScriptMetaData

public ScriptMetaData(StreamInput in)
               throws IOException

Throws:

IOException

Method Detail

fromXContent

public static ScriptMetaData fromXContent(XContentParser parser)
                                   throws IOException

This will parse XContent into ScriptMetaData. The following format will be parsed: { "<id>" : "<{@link StoredScriptSource#fromXContent(XContentParser, boolean)}>", "<id>" : "<{@link StoredScriptSource#fromXContent(XContentParser, boolean)}>", ... } When loading from a source prior to 6.0, if multiple scripts using the old namespace id format of [lang#id] are found to have the same id but different languages an error will occur.

Throws:

IOException

readDiffFrom

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

Throws:

IOException

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

toXContent

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

This will write XContent from ScriptMetaData. The following format will be written: { "<id>" : "<{@link StoredScriptSource#toXContent(XContentBuilder, Params)}>", "<id>" : "<{@link StoredScriptSource#toXContent(XContentBuilder, Params)}>", ... }

Specified by:

toXContent in interface ToXContent

Throws:

IOException

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>

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

context

public EnumSet<MetaData.XContentContext> context()

Specified by:

context in interface MetaData.Custom

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object