Package org.opensearch.client.opensearch._types

Class ScriptField.Builder

java.lang.Object

org.opensearch.client.util.ObjectBuilderBase

org.opensearch.client.opensearch._types.ScriptField.Builder

All Implemented Interfaces:

CopyableBuilder<ScriptField.Builder,ScriptField>, MutableBuilder<ScriptField.Builder,ScriptField>, ObjectBuilder<ScriptField>

Enclosing class:

ScriptField

public static class ScriptField.Builder
extends ObjectBuilderBase
implements CopyableBuilder<ScriptField.Builder,ScriptField>

Builder for ScriptField.

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ScriptField	build()	Builds a ScriptField.
ScriptField.Builder	copy()	Create a new builder CopyableBuilder that is a copy of this one.
final ScriptField.Builder	ignoreFailure(Boolean value)	Whether to ignore failures during script execution.
final ScriptField.Builder	script(Function<Script.Builder,ObjectBuilder<Script>> fn)	Required - The script to execute for this field.
final ScriptField.Builder	script(Script value)	Required - The script to execute for this field.

Methods inherited from class org.opensearch.client.util.ObjectBuilderBase

_checkSingleUse, _listAdd, _listAddAll, _listCopy, _mapCopy, _mapPut, _mapPutAll

Methods inherited from class java.lang.Object

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

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

applyMutation

Constructor Details

Builder

public Builder()

Method Details

copy

@Nonnull
public ScriptField.Builder copy()

Description copied from interface: CopyableBuilder

Create a new builder CopyableBuilder that is a copy of this one.

Specified by:

copy in interface CopyableBuilder<ScriptField.Builder,ScriptField>

Returns:

a new builder instance.

ignoreFailure

@Nonnull
public final ScriptField.Builder ignoreFailure(@Nullable
 Boolean value)

Whether to ignore failures during script execution.

API name: ignore_failure

script

@Nonnull
public final ScriptField.Builder script(Script value)

Required - The script to execute for this field.

API name: script

script

@Nonnull
public final ScriptField.Builder script(Function<Script.Builder,ObjectBuilder<Script>> fn)

Required - The script to execute for this field.

API name: script

build

@Nonnull
public ScriptField build()

Builds a ScriptField.

Specified by:

build in interface ObjectBuilder<ScriptField>

Throws:

NullPointerException - if some of the required fields are null.