Package org.opensearch.script

Class ScriptContextInfo

java.lang.Object

org.opensearch.script.ScriptContextInfo

All Implemented Interfaces:

Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject

public class ScriptContextInfo
extends Object
implements org.opensearch.common.xcontent.ToXContentObject, Writeable

Information about a script context

Opensearch.internal:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptContextInfo.ScriptMethodInfo	Script method information

Nested classes/interfaces inherited from interface org.opensearch.common.xcontent.ToXContent

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable

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

Field Summary

Fields

Modifier and Type	Field	Description
final ScriptContextInfo.ScriptMethodInfo	execute
final Set<ScriptContextInfo.ScriptMethodInfo>	getters
final String	name
static final org.opensearch.common.xcontent.ConstructingObjectParser<ScriptContextInfo,Void>	PARSER

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
ScriptContextInfo(String name, ScriptContextInfo.ScriptMethodInfo execute, Set<ScriptContextInfo.ScriptMethodInfo> getters)
ScriptContextInfo(StreamInput in)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
static ScriptContextInfo	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
String	getName()
int	hashCode()
List<ScriptContextInfo.ScriptMethodInfo>	methods()
org.opensearch.common.xcontent.XContentBuilder	toXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.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.opensearch.common.xcontent.ToXContentObject

isFragment

Field Details

name

public final String name

execute

public final ScriptContextInfo.ScriptMethodInfo execute

getters

public final Set<ScriptContextInfo.ScriptMethodInfo> getters

PARSER

public static final org.opensearch.common.xcontent.ConstructingObjectParser<ScriptContextInfo,Void> PARSER

Constructor Details

ScriptContextInfo

public ScriptContextInfo(String name,
 ScriptContextInfo.ScriptMethodInfo execute,
 Set<ScriptContextInfo.ScriptMethodInfo> getters)

ScriptContextInfo

public ScriptContextInfo(StreamInput in)
                  throws IOException

Throws:

IOException

Method Details

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

getName

public String getName()

methods

public List<ScriptContextInfo.ScriptMethodInfo> methods()

fromXContent

public static ScriptContextInfo fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                      throws IOException

Throws:

IOException

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toXContent

public org.opensearch.common.xcontent.XContentBuilder toXContent(org.opensearch.common.xcontent.XContentBuilder builder,
 org.opensearch.common.xcontent.ToXContent.Params params)
                                                          throws IOException

Specified by:

toXContent in interface org.opensearch.common.xcontent.ToXContent

Throws:

IOException