Record Class ScriptData

java.lang.Object

java.lang.Record

org.springframework.data.elasticsearch.core.query.ScriptData

Record Components:

language - the language when the script is passed in the script parameter

script - the script to use as inline script

scriptName - the name when using a stored script

params - the script parameters

public record ScriptData(@Nullable String language, @Nullable String script, @Nullable String scriptName, @Nullable Map<String,Object> params)
extends Record

value class combining script information.

A script is either an inline script, then the script parameters must be set or it refers to a stored script, then the name parameter is required.

Since:

4.4

Author:

Peter-Josef Meisch

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	ScriptData.Builder

Constructor Summary

Constructors

Constructor	Description
ScriptData(@Nullable String language, @Nullable String script, @Nullable String scriptName, @Nullable Map<String,Object> params)	Creates an instance of a ScriptData record class.

Method Summary

Modifier and Type	Method	Description
static ScriptData.Builder	builder()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
@Nullable String	language()	Returns the value of the language record component.
static ScriptData	of(@Nullable String language, @Nullable String script, @Nullable String scriptName, @Nullable Map<String,Object> params)	factory method to create a ScriptData object.
static ScriptData	of(Function<ScriptData.Builder, ScriptData.Builder> builderFunction)	factory method to create a ScriptData object using a ScriptBuilder callback.
@Nullable Map<String,Object>	params()	Returns the value of the params record component.
@Nullable String	script()	Returns the value of the script record component.
@Nullable String	scriptName()	Returns the value of the scriptName record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Constructor Details

ScriptData

public ScriptData(@Nullable String language,
 @Nullable String script,
 @Nullable String scriptName,
 @Nullable Map<String,Object> params)

Creates an instance of a ScriptData record class.

Parameters:

language - the value for the language record component

script - the value for the script record component

scriptName - the value for the scriptName record component

params - the value for the params record component

Method Details

of

public static ScriptData of(@Nullable String language,
 @Nullable String script,
 @Nullable String scriptName,
 @Nullable Map<String,Object> params)

factory method to create a ScriptData object.

Since:

5.2

of

public static ScriptData of(Function<ScriptData.Builder, ScriptData.Builder> builderFunction)

factory method to create a ScriptData object using a ScriptBuilder callback.

Parameters:

builderFunction - function called to populate the builder

Returns:

builder

public static ScriptData.Builder builder()

Since:

5.2

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

language

public @Nullable String language()

Returns the value of the language record component.

Returns:

the value of the language record component

script

public @Nullable String script()

Returns the value of the script record component.

Returns:

the value of the script record component

scriptName

public @Nullable String scriptName()

Returns the value of the scriptName record component.

Returns:

the value of the scriptName record component

params

public @Nullable Map<String,Object> params()

Returns the value of the params record component.

Returns:

the value of the params record component