Package org.opensearch.script

Class StoredScriptSource

java.lang.Object
org.opensearch.cluster.AbstractDiffable<StoredScriptSource>
org.opensearch.script.StoredScriptSource
All Implemented Interfaces:
Diffable<StoredScriptSource>, org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContent, org.opensearch.core.xcontent.ToXContentObject
@PublicApi(since="1.0.0") public class StoredScriptSource extends AbstractDiffable<StoredScriptSource> implements org.opensearch.core.common.io.stream.Writeable, org.opensearch.core.xcontent.ToXContentObject
StoredScriptSource represents user-defined parameters for a script saved in the ClusterState.
Opensearch.api:

  • 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 org.opensearch.core.ParseField
    LANG_PARSE_FIELD
    Standard ParseField for lang on the inner level.
    static final org.opensearch.core.ParseField
    OPTIONS_PARSE_FIELD
    Standard ParseField for options on the inner level.
    static final org.opensearch.core.ParseField
    SCRIPT_PARSE_FIELD
    Standard ParseField for outer level of stored script source.
    static final org.opensearch.core.ParseField
    SOURCE_PARSE_FIELD
    Standard ParseField for source on the inner level.

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor
    Description
    StoredScriptSource(String lang, String source, Map<String,String> options)
    Standard StoredScriptSource constructor.
    StoredScriptSource(org.opensearch.core.common.io.stream.StreamInput in)
    Reads a StoredScriptSource from a stream.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object o)
     
    static StoredScriptSource
    fromXContent(org.opensearch.core.xcontent.XContentParser parser, boolean ignoreEmpty)
    This will parse XContent into a StoredScriptSource.
    String
    getLang()
     
    Map<String,String>
    getOptions()
     
    String
    getSource()
     
    int
    hashCode()
     
    static StoredScriptSource
    parse(org.opensearch.core.common.bytes.BytesReference content, org.opensearch.core.xcontent.MediaType mediaType)
    This will parse XContent into a StoredScriptSource.
    static Diff<StoredScriptSource>
    readDiffFrom(org.opensearch.core.common.io.stream.StreamInput in)
    Required for ScriptMetadata.ScriptMetadataDiff.
    String
    toString()
     
    org.opensearch.core.xcontent.XContentBuilder
    toXContent(org.opensearch.core.xcontent.XContentBuilder builder, org.opensearch.core.xcontent.ToXContent.Params params)
    This will write XContent from a StoredScriptSource.
    void
    writeTo(org.opensearch.core.common.io.stream.StreamOutput out)
    Writes a StoredScriptSource to a stream.

    Methods inherited from class org.opensearch.cluster.AbstractDiffable

    diff, readDiffFrom

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.opensearch.core.xcontent.ToXContentObject

    isFragment

  • Field Details

    • SCRIPT_PARSE_FIELD

      public static final org.opensearch.core.ParseField SCRIPT_PARSE_FIELD
      Standard ParseField for outer level of stored script source.

    • LANG_PARSE_FIELD

      public static final org.opensearch.core.ParseField LANG_PARSE_FIELD
      Standard ParseField for lang on the inner level.

    • SOURCE_PARSE_FIELD

      public static final org.opensearch.core.ParseField SOURCE_PARSE_FIELD
      Standard ParseField for source on the inner level.

    • OPTIONS_PARSE_FIELD

      public static final org.opensearch.core.ParseField OPTIONS_PARSE_FIELD
      Standard ParseField for options on the inner level.

  • Constructor Details

    • StoredScriptSource

      public StoredScriptSource(String lang, String source, Map<String,String> options)
      Standard StoredScriptSource constructor.
      Parameters:
      lang - The language to compile the script with. Must not be null.
      source - The source source to compile with. Must not be null.
      options - Compiler options to be compiled with. Must not be null, use an empty Map to represent no options.

    • StoredScriptSource

      public StoredScriptSource(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Reads a StoredScriptSource from a stream. Version 5.3+ will read all of the lang, source, and options parameters. For versions prior to 5.3, only the source parameter will be read in as a bytes reference.
      Throws:
      IOException

  • Method Details

    • parse

      public static StoredScriptSource parse(org.opensearch.core.common.bytes.BytesReference content, org.opensearch.core.xcontent.MediaType mediaType)
      This will parse XContent into a StoredScriptSource. The following formats can be parsed:

      The simple script format with no compiler options or user-defined params:

      Example: {"script": "return Math.log(doc.popularity) * 100;"}

      The above format requires the lang to be specified using the deprecated stored script namespace (as a url parameter during a put request). See ScriptMetadata for more information about the stored script namespaces.

      The complex script format using the new stored script namespace where lang and source are required but options is optional:

      { "script" : { "lang" : "<lang>", "source" : "<source>", "options" : { "option0" : "<option0>", "option1" : "<option1>", ... } } }

      Example: { "script": { "lang" : "painless", "source" : "return Math.log(doc.popularity) * params.multiplier" } }

      The use of "source" may also be substituted with "code" for backcompat with 5.3 to 5.5 format. For example:

      { "script" : { "lang" : "<lang>", "code" : "<source>", "options" : { "option0" : "<option0>", "option1" : "<option1>", ... } } }

      Note that the "source" parameter can also handle template parsing including from a complex JSON object.

      Parameters:
      content - The content from the request to be parsed as described above.
      mediaType - The media type of the request
      Returns:
      The parsed StoredScriptSource.

    • fromXContent

      public static StoredScriptSource fromXContent(org.opensearch.core.xcontent.XContentParser parser, boolean ignoreEmpty)
      This will parse XContent into a StoredScriptSource. The following format is what will be parsed:

      { "script" : { "lang" : "<lang>", "source" : "<source>", "options" : { "option0" : "<option0>", "option1" : "<option1>", ... } } } Note that the "source" parameter can also handle template parsing including from a complex JSON object.

      Parameters:
      ignoreEmpty - Specify as true to ignoreEmpty the empty source check. This allows empty templates to be loaded for backwards compatibility.

    • readDiffFrom

      public static Diff<StoredScriptSource> readDiffFrom(org.opensearch.core.common.io.stream.StreamInput in) throws IOException
      Required for ScriptMetadata.ScriptMetadataDiff. Uses the StoredScriptSource(StreamInput) constructor.
      Throws:
      IOException

    • writeTo

      public void writeTo(org.opensearch.core.common.io.stream.StreamOutput out) throws IOException
      Writes a StoredScriptSource to a stream. Will write all of the lang, source, and options parameters.
      Specified by:
      writeTo in interface org.opensearch.core.common.io.stream.Writeable
      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
      This will write XContent from a StoredScriptSource. The following format will be written:

      { "script" : { "lang" : "<lang>", "source" : "<source>", "options" : { "option0" : "<option0>", "option1" : "<option1>", ... } } } Note that the 'source' parameter can also handle templates written as complex JSON.

      Specified by:
      toXContent in interface org.opensearch.core.xcontent.ToXContent
      Throws:
      IOException

    • getLang

      public String getLang()
      Returns:
      The language used for compiling this script.

    • getSource

      public String getSource()
      Returns:
      The source used for compiling this script.

    • getOptions

      public Map<String,String> getOptions()
      Returns:
      The compiler options used for this script.

    • 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