Module org.elasticsearch.server

Package org.elasticsearch.script

Class ScriptMetadata

java.lang.Object

org.elasticsearch.script.ScriptMetadata

All Implemented Interfaces:

Diffable<Metadata.ProjectCustom>, Metadata.MetadataCustom<Metadata.ProjectCustom>, Metadata.ProjectCustom, NamedDiffable<Metadata.ProjectCustom>, NamedWriteable, VersionedNamedWriteable, Writeable, ChunkedToXContent

public final class ScriptMetadata
extends Object
implements Metadata.ProjectCustom, Writeable

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 final 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.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static final String	TYPE	The type of ClusterState data.

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

EMPTY

Constructor Summary

Constructors

Constructor	Description
ScriptMetadata(StreamInput in)

Method Summary

Modifier and Type	Method	Description
EnumSet<Metadata.XContentContext>	context()
Diff<Metadata.ProjectCustom>	diff(Metadata.ProjectCustom 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.
TransportVersion	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.ProjectCustom>	readDiffFrom(StreamInput in)
String	toString()
Iterator<? extends ToXContent>	toXContentChunked(ToXContent.Params ignored)	Create an iterator of ToXContent chunks for a REST response.
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.common.xcontent.ChunkedToXContent

isFragment, toXContentChunked, toXContentChunkedV8

Methods inherited from interface org.elasticsearch.cluster.metadata.Metadata.MetadataCustom

isRestorable

Methods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable

supportsVersion

Field Details

TYPE

public static final String TYPE

The type of ClusterState data.

See Also:

• Constant Field Values

Constructor Details

ScriptMetadata

public ScriptMetadata(StreamInput in)
               throws IOException

Throws:

IOException

Method Details

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)}>", ... }

Throws:

IOException

readDiffFrom

public static NamedDiff<Metadata.ProjectCustom> 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

toXContentChunked

public Iterator<? extends ToXContent> toXContentChunked(ToXContent.Params ignored)

Description copied from interface: ChunkedToXContent

Create an iterator of ToXContent chunks for a REST response. Each chunk is serialized with the same XContentBuilder and ToXContent.Params, which is also the same as the ToXContent.Params passed as the params argument. For best results, all chunks should be O(1) size. The last chunk in the iterator must always yield at least one byte of output. See also ChunkedToXContentHelper for some handy utilities.

Note that chunked response bodies cannot send deprecation warning headers once transmission has started, so implementations must check for deprecated feature use before returning.

Specified by:

toXContentChunked in interface ChunkedToXContent

Returns:

iterator over chunks of ToXContent

diff

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

Description copied from interface: Diffable

Returns serializable object representing differences between this and previousState

Specified by:

diff in interface Diffable<Metadata.ProjectCustom>

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 TransportVersion getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to. See VersionedNamedWriteable.supportsVersion(TransportVersion) for the default serialization check.

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable

context

public EnumSet<Metadata.XContentContext> context()

Specified by:

context in interface Metadata.MetadataCustom<Metadata.ProjectCustom>

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