Package org.elasticsearch.script

Class ScriptLanguagesInfo

java.lang.Object
org.elasticsearch.script.ScriptLanguagesInfo
All Implemented Interfaces:
Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject
public class ScriptLanguagesInfo
extends java.lang.Object
implements org.elasticsearch.common.xcontent.ToXContentObject, Writeable
The allowable types, languages and their corresponding contexts. When serialized there is a top level types_allowed list, meant to reflect the setting script.allowed_types with the allowed types (eg inline, stored). The top-level language_contexts list of objects have the language (eg. painless, mustache) and a list of contexts available for the language. It is the responsibility of the caller to ensure these contexts are filtered by the script.allowed_contexts setting. The json serialization of the object has the form: { "types_allowed": [ "inline", "stored" ], "language_contexts": [ { "language": "expression", "contexts": [ "aggregation_selector", "aggs" ... ] }, { "language": "painless", "contexts": [ "aggregation_selector", "aggs", "aggs_combine", ... ] } ... ] }

  • Nested Class Summary

    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
    java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> languageContexts  
    static org.elasticsearch.common.xcontent.ConstructingObjectParser<ScriptLanguagesInfo,​java.lang.Void> PARSER  
    java.util.Set<java.lang.String> typesAllowed  

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

    EMPTY_PARAMS

  • Constructor Summary

    Constructors
    Constructor Description
    ScriptLanguagesInfo​(java.util.Set<java.lang.String> typesAllowed, java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> languageContexts)  
    ScriptLanguagesInfo​(StreamInput in)  

  • Method Summary

    Modifier and Type Method Description
    boolean equals​(java.lang.Object o)  
    static ScriptLanguagesInfo fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser)  
    int hashCode()  
    org.elasticsearch.common.xcontent.XContentBuilder toXContent​(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)  
    void writeTo​(StreamOutput out)
    Write this into the StreamOutput.

    Methods inherited from class java.lang.Object

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

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

    isFragment

  • Field Details

    • typesAllowed

      public final java.util.Set<java.lang.String> typesAllowed

    • languageContexts

      public final java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> languageContexts

    • PARSER

      public static final org.elasticsearch.common.xcontent.ConstructingObjectParser<ScriptLanguagesInfo,​java.lang.Void> PARSER

  • Constructor Details

    • ScriptLanguagesInfo

      public ScriptLanguagesInfo​(java.util.Set<java.lang.String> typesAllowed, java.util.Map<java.lang.String,​java.util.Set<java.lang.String>> languageContexts)

    • ScriptLanguagesInfo

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

  • Method Details

    • fromXContent

      public static ScriptLanguagesInfo fromXContent​(org.elasticsearch.common.xcontent.XContentParser parser) 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

    • 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

    • 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
      Specified by:
      toXContent in interface org.elasticsearch.common.xcontent.ToXContent
      Throws:
      java.io.IOException