Package org.opensearch.client.opensearch._types

Class ScriptField

java.lang.Object

org.opensearch.client.opensearch._types.ScriptField

All Implemented Interfaces:

JsonpSerializable, PlainJsonSerializable, ToCopyableBuilder<ScriptField.Builder,ScriptField>

@JsonpDeserializable
@Generated("org.opensearch.client.codegen.CodeGenerator")
public class ScriptField
extends Object
implements PlainJsonSerializable, ToCopyableBuilder<ScriptField.Builder,ScriptField>

The configuration for a script field.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ScriptField.Builder	Builder for ScriptField.

Field Summary

Fields

Modifier and Type	Field	Description
static final JsonpDeserializer<ScriptField>	_DESERIALIZER	Json deserializer for ScriptField

Method Summary

Modifier and Type	Method	Description
static ScriptField.Builder	builder()
boolean	equals(Object o)
int	hashCode()
final Boolean	ignoreFailure()	Whether to ignore failures during script execution.
static ScriptField	of(Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)
final Script	script()	Required - The script to execute for this field.
void	serialize(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)	Serialize this object to JSON.
protected void	serializeInternal(jakarta.json.stream.JsonGenerator generator, JsonpMapper mapper)
protected static void	setupScriptFieldDeserializer(ObjectDeserializer<ScriptField.Builder> op)
ScriptField.Builder	toBuilder()	Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opensearch.client.json.PlainJsonSerializable

toJsonString

Methods inherited from interface org.opensearch.client.util.ToCopyableBuilder

copy

Field Details

_DESERIALIZER

public static final JsonpDeserializer<ScriptField> _DESERIALIZER

Json deserializer for ScriptField

Method Details

of

public static ScriptField of(Function<ScriptField.Builder,ObjectBuilder<ScriptField>> fn)

ignoreFailure

@Nullable
public final Boolean ignoreFailure()

Whether to ignore failures during script execution.

API name: ignore_failure

script

@Nonnull
public final Script script()

Required - The script to execute for this field.

API name: script

serialize

public void serialize(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

Serialize this object to JSON.

Specified by:

serialize in interface JsonpSerializable

serializeInternal

protected void serializeInternal(jakarta.json.stream.JsonGenerator generator,
 JsonpMapper mapper)

toBuilder

@Nonnull
public ScriptField.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Create a new builder ToCopyableBuilder that is initialised with the current state of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ScriptField.Builder,ScriptField>

Returns:

a new builder instance.

builder

@Nonnull
public static ScriptField.Builder builder()

setupScriptFieldDeserializer

protected static void setupScriptFieldDeserializer(ObjectDeserializer<ScriptField.Builder> op)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object