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, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentFragment
public final class ScriptMetadata
extends java.lang.Object
implements Metadata.Custom, Writeable, org.elasticsearch.common.xcontent.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

    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 java.lang.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
    java.util.EnumSet<Metadata.XContentContext> context()  
    Diff<Metadata.Custom> diff​(Metadata.Custom before)
    Returns serializable object representing differences between this and previousState
    boolean equals​(java.lang.Object o)  
    static ScriptMetadata fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)
    This will parse XContent into ScriptMetadata.
    Version getMinimalSupportedVersion()
    The minimal version of the recipient this object can be sent to
    java.lang.String getWriteableName()
    Returns the name of the writeable object
    int hashCode()  
    static NamedDiff<Metadata.Custom> readDiffFrom​(StreamInput in)  
    java.lang.String toString()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.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 Details

  • Constructor Details

    • ScriptMetadata

      public ScriptMetadata​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

  • Method Details

    • fromXContent

      public static ScriptMetadata fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.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:
      java.io.IOException

    • readDiffFrom

      public static NamedDiff<Metadata.Custom> readDiffFrom​(StreamInput in) throws java.io.IOException
      Throws:
      java.io.IOException

    • writeTo

      public void writeTo​(StreamOutput out) throws java.io.IOException
      Description copied from interface: Writeable
      Write this into the StreamOutput.
      Specified by:
      writeTo in interface Writeable
      Throws:
      java.io.IOException

    • toXContent

      public org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.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 org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.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 java.lang.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 java.util.EnumSet<Metadata.XContentContext> context()
      Specified by:
      context in interface Metadata.Custom

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object